Документация по API интеграции
API NumCheck позволяет осуществлять запросы на наши сервера для инициализации различных методов, например, для запроса на осуществление авторизации. Использовать наше API может каждый клиент NumCheck, прошедший регистрацию.
Определение понятий
-
Сервис - необходим для работы с нашим API. Сервис создается самостоятельно в Личном кабинете в разделе "Мои сервисы". Сервис позволяет просматривать детальную статистику авторизаций и производить тонкие настройки для работы с API. Каждый сервис имеет уникальный идентификатор (ID сервиса) и специальный, случайно сгенерированный, секретный ключ.
-
Авторизация - мы называем авторизацией все инициализируемые звонки Вашим клиентам с помощью API-метода init-call.
-
Секретный ключ - специальный, уникальный и случайно сгенерированный набор 32 символов. Позволяет обращаться к нашему API. В случае, если секретный ключ скомпрометирован, Вы можете в любое время сгенерировать новый секретный ключ в настройках сервиса в Личном кабинете.
Что требуется для работы с API?
-
Для работы с API требуется пройти регистрацию, после чего необходимо войти в личный кабинет. Затем перейти на вкладку "Мои сервисы", после чего создать новый сервис или перейти к управлению уже созданным ранее.
-
Для работы с API Вам потребуется "Секретный ключ" сервиса и воспользоваться методом init-call.
-
Это все, что Вам потребуется для начала работы.
Метод init-call
Метод предназначен для отправки запроса на осуществление звонка на указанный телефонный номер пользователя, для дальнейшей авторизации пользователя в системе клиента. Пользователю будет отправлен звонок, а клиенту данные по этому звонку.
Метод принимает следующие параметры
| Параметр | Значение | Описание |
|---|---|---|
| X-AUTH-Token заголовок |
string 32 символа required |
Секретный ключ Вашего сервиса |
| phone GET параметр |
number required |
Номер телефона пользователя, которому будет совершён звонок с авторизацией |
| description GET параметр |
string до 64 символов optional |
Информацию о пользователе. Можете передать информацию о Вашем пользователе, например, особую метку, его никнейм, E-mail и так далее. |
Пример запроса
$client_phone = 79991234567;
$request_description = 'some nickname';
-X "POST" \
-H "X-AUTH-Token: $secret_key"
Метод возвращает следующие параметры
| Параметр | Описание |
|---|---|
| callId | Уникальный ID в системе NumCheck, который позволит проверить статус звонка с помощью метода get-call-info |
| callerId | Телефонный номер, с которого наша система осуществила звонок |
| code | Код, который является последними 4 цифрами в номере телефона, с которого наша система осуществила звонок |
| statusCode | HTTP код ответа |
| errorCode | Код ошибки |
| message | Сообщение об ошибке |
| success | Статус выполнения запроса |
Пример ответа
"callId": 33168,
"callerId": 37166004953,
"code": 4953,
"statusCode": 200,
"errorCode": 0,
"message": null,
"success": true
}
Метод get-call-info
Метод предназначен для получения информации о осуществлённом звонке.
Метод принимает следующие параметры
| Параметр | Значение | Описание |
|---|---|---|
| X-AUTH-Token заголовок |
string 32 символа required |
Секретный ключ Вашего сервиса |
| callId GET параметр |
number required |
ID в системе NumCheck, переданный ранее в ответе запроса init-call |
Пример запроса
$call_id = 1080;
-X "POST" \
-H "X-AUTH-Token: $secret_key"
Метод возвращает следующие параметры
| Параметр | Описание |
|---|---|
| callId | Уникальный ID в системе NumCheck |
| callerId | Телефонный номер, с которого наша система осуществила звонок |
| code | Код, который является последними 4 цифрами в номере телефона, с которого наша система осуществила звонок |
| status | Статус звонка 0 - звонок в процессе 1 - звонок осуществлён успешно -1 - звонок не был принят пользователем |
| statusCode | HTTP код ответа |
| errorCode | Код ошибки |
| message | Сообщение об ошибке |
| success | Статус выполнения запроса |
Пример ответа
"callId": 33168,
"callerId": 37166004953,
"code": 4953,
"status": 1,
"statusCode": 200,
"errorCode": 0,
"message": null,
"success": true
}