Пример 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-key | string | Api Key пользователя |
x-vsaas-session | string | Session key, для авторизованных пользователей |
(ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:Ключ | Тип | Описание |
---|
search | string | поиск |
limit | integer | ограничивает количество выходных данных |
offset | integer | указывает число строк, которое необходимо пропустить в общем массиве данных |
Ответ:Ключ | Тип | Описание |
---|
result | array | массив стран |
id | integer | идентификатор страны. |
name | string | название страны. |
phone_mask | string | маска номера телефона. |
phone_code | string | код номера телефона. |
country_prefix | string | ISO код страны. |
iso_code | string | ISO код страны в сокращенном формате. |
success | boolean | информация о статусе запроса |
GET/api/v2/directory/cities
Заголовки:Ключ | Тип | Описание |
---|
x-vsaas-api-key | string | Api Key пользователя |
x-vsaas-session | string | Session key, для авторизованных пользователей |
(ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:Ключ | Тип | Описание |
---|
countryId | integer | идентфикатор страны |
search | string | поиск |
limit | integer | ограничивает количество выходных данных |
offset | integer | указывает число строк, которое необходимо пропустить в общем массиве данныx |
Ответ:Ключ | Тип | Описание |
---|
result | object | объект,содержащий ответ от сервера |
result | array | массив городов |
city_id | integer | идентификатор города |
city_title | string | название города |
gps | string | координаты города |
region_title | string | название региона |
success | boolean | информация о статусе запроса |