8 (800) 222-3249
Поделиться с друзьями

Документация по API - Запросы к серверу

Вызов API осуществляется посредством вызова URL по данному шаблону:

https://my.callbaska.ru/api/methodName/?user_id=USER_ID&secret=SECRET_KEY&format=json&param1=value1&param2=value2 ...

Также возможно передавать параметры через POST-запрос

https://my.callbaska.ru/api/methodName/

user_id=USER_ID
secret=SECRET_KEY
format=json
param1=value1
param2=value2
...

Описание основных параметров:

user_id (обязательный)

Параметр должен быть равен USER_ID Вашего пользователя в системе (указан в разделе API вашего личного кабинета).

secret (обязательный)

Параметр должен быть равен Вашему SECRET_KEY в системе (указан в разделе API вашего личного кабинета).

format (необязательный)

Формат получаемого ответа от сервера. Параметр может иметь значения: json, xml.

По умолчанию равен json

Описание методов (methodName):

getRequests

Описание:

Возвращает список запросов

Передаваемые параметры

site_id (необязательный)

ID сайта(ов), по которым нужно получить запросы. Тип параметра - integer. Можно указывать несколько значений через запятую.

По умолчанию равен 0 - получаем запросы по всем сайтам

form_id (необязательный)

ID форм(ы), по которым нужно получить запросы. Тип параметра - integer. Можно указывать несколько значений через запятую.

По умолчанию равен 0 - получаем запросы по всем формам.

count (необязательный)

Количество получаемых элементов в ответе. Тип параметра - integer. Максимальное значение - 200.

По умолчанию равен 200

page (необязательный)

Номер страницы для получения запросов, выходящих за пределы параметра count. Тип параметра - integer.

По умолчанию равен 1

order (необязательный)

Сортировка запросов в ответе. Параметр может иметь значения: asc, desc.

По умолчанию равен desc

date_from (необязательный)

Начальная дата запросов в ответе. Параметр указывается в формате YYYY-MM-DD, например 2019-01-01.

По умолчанию не указан - получаем запросы за все даты

date_to (необязательный)

Конечная дата запросов в ответе. Параметр указывается в формате YYYY-MM-DD, например 2019-12-31.

По умолчанию не указан - получаем запросы за все даты


Пример:

https://my.callbaska.ru/api/getRequests/?user_id=1&secret=XXXXXXXXXXXXXXXX&site_id=1,2&form_id=1,2&date_from=2019-01-01&date_to=2019-12-31&page=1&order=desc

Свяжитесь со специалистом

Позвоните нам по телефону
8 (800) 222-3249

или оставьте заявку и наш менеджер свяжется
с вами в ближайшее время

Наверх