Построение запросов к API


Обмен данными с помощью API осуществляется по протоколу HTTPS с использованием способа передачи данных POST или GET на точку входа в зависимости от типа запроса XML или JSON.

Точки входа:

JSON - https://api.novaposhta.ua/v2.0/json/
XML - https://api.novaposhta.ua/v2.0/xml/

Портал разработчика позволяет тестировать ваши запросы непосредственно на странице описания того или иного метода, также возможно протестировать запрос с программной среды «Postman».

Протестировать API на портале

Протестировать API в Postman



Также для вашего удобства мы предоставляем возможность интеграции API Нова пошта c Вашими онлайн сервисами.

Ниже приведен пример формирования запроса на основе запроса к методу getServiceTypes - Справочник технологий доставки. На примере языка PHP cURL:

< ? php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.novaposhta.ua/v2.0/json/",
CURLOPT_RETURNTRANSFER => True,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\r\n\"apiKey\": \"\",\r\n\"modelName\": \"Common\",\r\n\"calledMethod\": \"getServiceTypes\",\r\n\"methodProperties\": {}\r\n}",
CURLOPT_HTTPHEADER => array("content-type: application/json",),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>

Пример формирования запроса онлайн поиска улиц в справочнике населенных пунктов, на примере языка JavaScript:

$(function() {
  var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.novaposhta.ua/v2.0/json/",
  "method": "POST",
  "headers": {
    "content-type": "application/json",

  },
  "processData": false,
  "data": "{\r\n\"apiKey\": \"\",\r\n \"modelName\": \"Address\",\r\n \"calledMethod\": \"searchSettlements\",\r\n \"methodProperties\": {\r\n \"CityName\": \"васильевка\",\r\n \"Limit\": 5\r\n }\r\n}"
}

$.ajax(settings).done(function (response) {> console.log(response);
});
});

Postman позволяет получить код на всех основных языках программирования. Для формирования кода на основе API запроса, рекомендуем ознакомиться с видео инструкцией.

Готовый код на основе API запроса