Реализация запросов к серверу CDEK по API на PHP на примере получения авторизационного токена и калькуляции.

<?php
ini_set('error_reporting',E_ALL);
ini_set('display_errors',1);
ini_set('display_startup_errors',1);

include_once("apiKeys.php");/*в этом файле только определяются 2 переменных $clientId и $clientSecret, это API ключи выданные интернет магазину который интегрируем с CDEK, Вам необходимо получить свои ключи */
//Строчкой ниже простая проверка чтобы Вы не игрались с данным примером, если у Вас ещё нет API ключей для интеграции с CDEK
if (!(isset($clientId) and isset($clientSecret) and (($clientId."") != "") and (($clientSecret."") != ""))) {echo "Вы не заполнили \$clientId или \$clientSecret необходимые для получения авторизационного токена.";exit;}

// В строчке ниже объект содержащий запрос, этот объект необходимо передавать представленным в виде строки JSON, в строчке ниже переменной сразу же присваивается строка JSON
$requestObjectString = '{"type":"2","date":"2021-04-03T11:49:32+0700","currency":"1","lang":"rus","tariff_code":"11","from_location":{"code":"270"},"to_location":{"code":"44"},"services":[{"code":"PACKAGE_1","parameter":"2"}],"packages":[{"height":10,"length":10,"weight":4000,"width":10}]}';

//[НАЧАЛО]Первый запрос(получение авторизационного токена)
$curl1 = curl_init();//Инициализируем переменную CURL

$postFieldsAr = array(//В 3-х строчках ниже данные которые передаются методом POST в первом запросе(то есть в запросе авторизационного токена), в втором запросе они не используются
  "grant_type" => "client_credentials",//Тип
  "client_id" => $clientId,//Идентификатор клиента
  "client_secret" => $clientSecret//Секретный ключ клиента
);

curl_setopt_array($curl1,array(
  CURLOPT_URL => "https://api.cdek.ru/v2/oauth/token?parameters",//URL на который отправляем запрос, в данном случаи это URL получения авторизационного токена
  CURLOPT_RETURNTRANSFER => true,//Устанавливаем этот параметр в true чтобы сохранить результат запроса в переменную иначе вывод сразу же будет направлен в браузер
  CURLOPT_POST => true,//Указываем что данные отправляются методом POST
  CURLOPT_POSTFIELDS => http_build_query($postFieldsAr)//Кодирование массива с оправляемыми данными для передачи методом POST
));

$response = curl_exec($curl1);//Сохраняем тело ответа от сервера CDEK в переменную $response
curl_close($curl1);
//[КОНЕЦ]Первый запрос(получение авторизационного токена)

//[НАЧАЛО]Декодируем полученный ответ из JSON проверяем наличие свойства access_token и если данное свойство не пустое присваиваем его переменной $authToken
$objJSON1 = json_decode($response);
if ($objJSON1 === false) {
  echo "Ошибка, сервер CDEK вернул ответ не в JSON формате.";exit;
}

if (isset($objJSON1->access_token) and (($objJSON1->access_token."") != "")) {
  $authToken = $objJSON1->access_token;
} else {
  echo "Ошибка, ответ сервера CDEK не содержит свойства access_token или этот параметр пустой.";exit;
}
//[КОНЕЦ]Декодируем полученный ответ из JSON проверяем наличие свойства access_token и если данное свойство не пустое присваиваем его переменной $authToken

//В данном примере access_token получается при каждом вызове скрипта, в реальных же проектах имеет смысл куда либо сохранять токен, хранить пока он действительный и повторно использовать, чтобы каждый раз не получать токен и таким образом избежать запросов в которых нет необходимости

//[НАЧАЛО]Второй запрос(калькуляция стоимости доставки в зависимости от тарифного плана, городов отправки и доставки, а так же параметров груза)
$curl2 = curl_init();//Инициализируем переменную вторую переменную CURL, хотя ничего не мешает использовать ту же самую, подход с двумя переменными используется для наглядного разделения двух запросов к серверу CDEK

$header = array();//Создание массива в котором будут хранится заголовки отправляемые серверу CDEK
//$header[] = "Accept: application/json";//Этим заголовком можно указать серверу CDEK что в качестве ответа от него ожидается JSON строка, он закомментирован поскольку его наличие не обязательно
$header[] = "Content-Type: application/json; charset=utf-8";//Этот заголовок указывает что данные передаваемые пост запросом имеют формат JSON строки и имеют кодировку UTF-8
$header[] = "Authorization: Bearer " . $authToken;//Этот заголовок передаёт авторизационный токен, который был получен в первом запросе

curl_setopt_array($curl2,array(
  CURLOPT_URL => 'https://api.cdek.ru/v2/calculator/tariff',//URL на который отправляем запрос, в данном случаи это URL калькулятора расчёта доставки
  CURLOPT_RETURNTRANSFER => true,//Этот параметр установлен для того чтобы результат сохранялся в переменную а не сразу выводился в браузер
  CURLOPT_HTTPHEADER => $header,//Передаём массив заголовков подготовленный ранее, который содержит в частности заголовок с авторизационным токеном
  CURLOPT_POST => true,//Указываем что данные отправляются методом POST
  CURLOPT_POSTFIELDS => $requestObjectString//Передача в качестве POST данных подготовленный ранее объект в виде строки JSON
));

$response2 = curl_exec($curl2);//Сохраняем тело ответа второго запроса от сервера CDEK в переменную $response2
curl_close($curl2);
//[КОНЕЦ]Второй запрос(калькуляция стоимости доставки в зависимости от тарифного плана, городов отправки и доставки, а так же параметров груза)

var_dump($response2);//выводим информацию полученную от сервера CDEK содержащую информацию о доставке после её расчёта в соответствии с переданными параметрами о грузе, адресов отправки и доставки, информации о тарифном плане

Если Вы скопировали код скрипта из листинга выше, создали файл apiKeys.php и указали в нём переменные $clientId и $clientSecret(или указали их в файле основного скрипта) в браузере Вы должны увидеть результат расчёта доставки полученный от API сервера CDEK аналогичный тому, что я привёл на скринсшоте ниже.

Пример API ответа сервер CDEK после расчёта стоимости доставки

Причины возникновения ошибки "Unsupported Media Type" с кодом 415

Если при запросе информации по api с сервера СДЭК у Вас возникла ошибка Unsupported Media Type с статусом 415, причиной её возникновения является отсутствие в Вашем запросе заголовка Content-Type: application/json; charset=utf-8, который говорит серверу о том, что переданные в POST данные являются закодированной строкой JSON и имеют кодировку UTF-8. Это так же может быть понятно из текста ошибки, перевод которой может означать, что сервер CDEK не смог распознать тип передаваемых данных.

В моей практике было что такая ошибка сопровождалась HTML выводом информации с стороны сервера, хотя на выходе предполагается JSON, не смотря на то что видимо данный момент уже поправили и теперь запросы к URL сервера CDEK из примера выше всегда возвращают JSON, тем не менее ранее эту ситуацию можно было поправить, если дополнительно было передать заголовок Accept: application/json, который означает что клиент ожидает от сервера именно JSON закодированную строку и она бы возвращалась сервером CDEK даже при отсутствии заголовка Content-Type. То-есть ещё раз повторю в чём же отличие заголовка Content-Type от Accept: первый заголовок показывает тип содержимого который клиент направляет серверу(если разумеется этот заголовок передаёт именно клиент, а не сервер, в противном случаи заголовок бы обозначал тип контента который вернул сервер для клиента), второй заголовок означает формат данных, с которыми умеет работать клиент и соответственно данные именно в этом формате клиент ожидает получить от сервера.

На скринсшоте ниже приведён пример как выглядит описанная ошибка в браузере, если в коде из листинга выше не передать заголовок Content-Type.

Ошибка Unsupported Media Type с статусом 415 в ответе полученном по api от серера CDEK

Причины возникновения ошибки "Unsupported Media Type" с кодом 415

Комментарии