Запросы к API

Взаимодействие с API происходит только по защищенному протоколу https.

Базовый URL API

Базовый URL-адрес API: https://api.pkge.net/v1

Заголовки

Все запросы должны содержать следующие обязательные заголовки:

Подробнее о заголовке X-Api-Key читайте в разделе "Аутентификация".

Разворачивание связанных объектов

При необходимости в ответах API можно "развернуть" связанные объекты. Например, в модели Package вместо свойства с идентификатором службы доставки (courier_id), которая доставляет посылку в данный момент, будет возвращен соответствующий объект Courier в свойстве courier. Для этого к запросу необходимо добавить следующий заголовок:

Подробнее о разворачиваемых свойствах читайте в разделах документации по каждому объекту.

Локализация ответов

Чтобы получить ответ (например, список чекпоинтов для посылки) на нужном языке вместо языка по-умолчанию, необходимо передавать в запросах дополнительный заголовок :

Где {CODE} - код одного из поддерживаемых API языков:

Код языка	Название
de	Deutsch
en	English
es	Español
fr	Français
id	Bahasa Indonesia
it	Italiano
ja	日本語
ko	한국어
nl	Nederlands
pl	Polski
pt	Português
ru	Русский
th	ไทย
tr	Türkçe
uk	Українська
zh	汉语

Ограничение частоты запросов

У API существует ограничение на 10 запросов в секунду для каждого отдельного ключа API. В случае превышения этого лимита сервер вернет неуспешный ответ с кодом 429.

Помимо этого в ответе на каждый запрос будут переданы дополнительные заголовки с информацией о текущем статусе частоты запросов:

Заголовок	Описание
X-Rate-Limit-Limit	Максимальное количество запросов, разрешённое в течение периода времени.
X-Rate-Limit-Remaining	Оставшееся количество разрешённых запросов в текущем периоде времени.
X-Rate-Limit-Reset	Количество секунд, которое нужно подождать до получения максимального количества разрешённых запросов.