API Адреса

Работа с адресами

Справочник географических областей Украины

Метод «getAreas», работает в модели «Address», этот метод необходим для скачивания справочника географических областей Украины, компании «Новая Почта».
Рекомендуется проводить обновление справочников раз в месяц.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]/
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties   Свойства метода
* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Address",
"calledMethod": "getAreas",
"methodProperties": {}
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Address</modelName>
<calledMethod>getAreas</calledMethod>
</file>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор Области
Description string[50] Описание на украинском языке
AreasCenter string[36] Идентификатор города, который является областным центром

{
    "success": true,
    "data": [
        {
            "Description": "АРК",
            "Ref": "71508128-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88b7-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Вінницька",
            "Ref": "71508129-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88de-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Волинська",
            "Ref": "7150812a-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c893b-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Дніпропетровська",
            "Ref": "7150812b-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88f0-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Донецька",
            "Ref": "7150812c-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88bf-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Житомирська",
            "Ref": "7150812d-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88c4-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Закарпатська",
            "Ref": "7150812e-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "e221d627-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Запорізька",
            "Ref": "7150812f-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88c6-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Івано-Франківська",
            "Ref": "71508130-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8904-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Київська",
            "Ref": "71508131-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "8d5a980d-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Кіровоградська",
            "Ref": "71508132-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c891b-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Луганська",
            "Ref": "71508133-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88ba-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Львівська",
            "Ref": "71508134-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88f5-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Миколаївська",
            "Ref": "71508135-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c888c-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Одеська",
            "Ref": "71508136-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88d0-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Полтавська",
            "Ref": "71508137-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8892-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Рівненська",
            "Ref": "71508138-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c896a-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Сумська",
            "Ref": "71508139-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88e5-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Тернопільська",
            "Ref": "7150813a-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8900-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Харківська",
            "Ref": "7150813b-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88e0-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Херсонська",
            "Ref": "7150813c-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88cc-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Хмельницька",
            "Ref": "7150813d-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c88ac-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Черкаська",
            "Ref": "7150813e-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c8902-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Чернівецька",
            "Ref": "7150813f-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "e221d642-391c-11dd-90d9-001a92567626"
        },
        {
            "Description": "Чернігівська",
            "Ref": "71508140-9b87-11de-822f-000c2965ae0e",
            "AreasCenter": "db5c897c-391c-11dd-90d9-001a92567626"
        }
    ],
    "errors": [],
    "warnings": [],
    "info": []
}
<root>
	<success>true</success>
	<data>
		<item>
			<Description>АРК</Description>
			<Ref>71508128-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88b7-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Вінницька</Description>
			<Ref>71508129-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88de-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Волинська</Description>
			<Ref>7150812a-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c893b-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Дніпропетровська</Description>
			<Ref>7150812b-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88f0-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Донецька</Description>
			<Ref>7150812c-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88bf-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Житомирська</Description>
			<Ref>7150812d-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88c4-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Закарпатська</Description>
			<Ref>7150812e-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>e221d627-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Запорізька</Description>
			<Ref>7150812f-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88c6-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Івано-Франківська</Description>
			<Ref>71508130-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c8904-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Київська</Description>
			<Ref>71508131-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>8d5a980d-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Кіровоградська</Description>
			<Ref>71508132-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c891b-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Луганська</Description>
			<Ref>71508133-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88ba-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Львівська</Description>
			<Ref>71508134-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88f5-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Миколаївська</Description>
			<Ref>71508135-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c888c-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Одеська</Description>
			<Ref>71508136-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88d0-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Полтавська</Description>
			<Ref>71508137-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c8892-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Рівненська</Description>
			<Ref>71508138-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c896a-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Сумська</Description>
			<Ref>71508139-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88e5-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Тернопільська</Description>
			<Ref>7150813a-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c8900-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Харківська</Description>
			<Ref>7150813b-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88e0-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Херсонська</Description>
			<Ref>7150813c-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88cc-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Хмельницька</Description>
			<Ref>7150813d-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c88ac-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Черкаська</Description>
			<Ref>7150813e-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c8902-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Чернівецька</Description>
			<Ref>7150813f-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>e221d642-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
		<item>
			<Description>Чернігівська</Description>
			<Ref>71508140-9b87-11de-822f-000c2965ae0e</Ref>
			<AreasCenter>db5c897c-391c-11dd-90d9-001a92567626</AreasCenter>
		</item>
	</data>
	<errors />
	<warnings />
	<info />
</root>