Проверка в реальном времени
Проверка в реальном времени отвечает на один вопрос об одном идентификаторе сразу: зарегистрирован ли этот номер телефона — или этот адрес электронной почты — на заданной платформе?
Движок тот же, что использует консоль. Он принимает номер телефона или адрес электронной почты, проверяет его по одному — десяти продуктам реального времени и возвращает вердикт по каждому продукту.
Когда использовать
Заголовок раздела «Когда использовать»| У вас есть | Используйте |
|---|---|
| Один идентификатор или несколько, и ответ нужен сейчас | Проверку в реальном времени |
| Тысячи идентификаторов, и вы можете подождать | Массовая проверка |
Типичные случаи реального времени — валидация формы при регистрации или оформлении заказа, разовые проверки внутри внутреннего инструмента и небольшое число проверок внутри уже запущенного процесса. Массовая проверка создана для файлов и больших массивов: она асинхронна, тарифицируется по каждой проверенной строке, а завершённые задачи можно скачать.
Две серии, один контракт
Заголовок раздела «Две серии, один контракт»Серия передаётся в пути, и она должна соответствовать выбранным продуктам:
| Серия | Endpoint | identifier |
|---|---|---|
| Телефон | POST /v1/realtime/check/phone | Номер в формате E.164, например +8613800138000 |
POST /v1/realtime/check/email | Адрес электронной почты, например user@example.com |
Запрос не может смешивать серии: выбор телефонного продукта и email-продукта в одном вызове отклоняется. country необязателен для полного номера E.164 и должен быть опущен для email.
Как считается один вызов
Заголовок раздела «Как считается один вызов»Один вызов принимает один идентификатор и от одного до десяти продуктов:
- один
request_idна вызов - одна запись на продукт в
results - одно списание на запись
Поскольку каждая запись тарифицируется отдельно, вызов может завершиться успешно для одних продуктов и неудачно для других. Это отражается как status: partial_succeeded, и каждая запись несёт свой billing_status — читайте их, а не полагайтесь на один только HTTP 200.
Страницы этого раздела
Заголовок раздела «Страницы этого раздела»- Проверка телефона в реальном времени — телефонный эндпоинт целиком
- Проверка email в реальном времени — email-эндпоинт целиком
- Продукты реального времени — актуальный список продуктов для выбора и как считать из него ID
- Идемпотентность и повторы — почему
Idempotency-Keyобязателен и как ведут себя повторы - Биллинг и возвраты — что списывается, что возвращается и когда
- Примеры cURL / SDK — готовые вызовы для типовых случаев
Перед первым вызовом
Заголовок раздела «Перед первым вызовом»- Получите API-ключ — см. Authentication.
- Считайте ID продуктов, которые собираетесь использовать, из Продукты реального времени.
- Передавайте уникальный
Idempotency-Keyс каждым вызовом; он обязателен, а не опционален.