Справочник


Пример curl-запроса на получение списка российских городов:

curl –location --requestGET 'http://cloud.dvor24.com/api/v2/directory/cities?countryId=1' --header 'X-Vsaas-Api-Key: КЛЮЧ-API' --header 'X-Vsaas-Session: ТОКЕН-АВТОРИЗАЦИИ'

Получение стран

GET/api/v2/directory/countries

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
searchstringпоиск
limitintegerограничивает количество выходных данных
offsetintegerуказывает число строк, которое необходимо пропустить в общем массиве данных
Ответ:
КлючТипОписание
resultarrayмассив стран
successbooleanинформация о статусе запроса

Получение городов

GET/api/v2/directory/cities

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
countryIdintegerидентфикатор страны
searchstringпоиск
limitintegerограничивает количество выходных данных
offsetintegerуказывает число строк, которое необходимо пропустить в общем массиве данныx
Ответ:
КлючТипОписание
resultobjectобъект,содержащий ответ от сервера
successbooleanинформация о статусе запроса