Документация по API
Документация описывает enKod API и предназначена для разработчиков, задачей которых является интеграция enKod с различными системами и сервисами.
Кроме того, API можно использовать для получения развернутой информации о персонах в enKod, действий с сообщениями, просмотра статистики и работой с таблицами данных. Для каждого API метода в документации приведены необходимые параметры, примеры запросов и пояснения возможных ответов.
Для работы с enKod API необходимо создать API-ключ. Для этого перейдите в enKod»Настройки»API и создайте ключ со всеми необходимыми правами. Все примеры из документации по API необходимо изменять в соответствии с вашим рабочим API-ключом.
Ознакомиться со всеми существующими методами вы можете по ссылке
Особенности передачи данных
Номера телефонов должны иметь валидный синтаксис, т.е. соответствовать правилам -
- содержать от 11 до 15 символов включительно (символ + может быть использован, но это необязательно)
- содержать только числа (кроме символа +)
- номер не может начинаться с 0
- символ + не может находиться внутри или в конце номера
- номер не может содержать специальные символы, пробелы, знаки препинания и др.
Тестирование запросов через Postman
Ниже приведена краткая инструкция по тестированию API-запросов в Postman для всех возможных форматов их записи в документации.
POST-запросы
Документация
Postman
GET-запросы
Вариант 1
Документация
Postman
Вариант 2
Документация
Postman
Вариант 3
Документация
Postman
