API Документация

TrackExpress.RU предоставляет REST API для интеграции отслеживания посылок в ваши приложения.

Базовый URL

https://www.trackexpress.ru/api/v1

Аутентификация

API использует ключи для аутентификации. Вы можете получить API ключ в разделе Профиль.

Способы передачи API ключа:

  • Параметр запроса: ?api_key=YOUR_KEY
  • HTTP заголовок: X-API-Key: YOUR_KEY
  • Authorization заголовок: Authorization: Bearer YOUR_KEY

Без API ключа: лимит 10 запросов в минуту
С API ключом: лимит 100 запросов в минуту

Отслеживание посылки

GET /api/v1/track

Получить информацию о посылке по трек-коду

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

  • track (обязательный) - трек-код посылки (4-50 символов)
  • api_key (опционально) - API ключ для увеличенного лимита

Пример запроса:

GET /api/v1/track?track=LK908505724CN&api_key=YOUR_API_KEY

Или с заголовком:

GET /api/v1/track?track=LK908505724CN
X-API-Key: YOUR_API_KEY

Пример ответа:

{
  "success": true,
  "tracking_code": "LK908505724CN",
  "status": "in-transit",
  "status_localized": "В пути",
  "courier_name": "China Post",
  "origin_country": "CN",
  "destination_country": "RU",
  "events": [
    {
      "date": "2024-01-15 10:30:00",
      "status": "in-transit",
      "location": "Beijing, China",
      "description": "Посылка отправлена"
    }
  ]
}

Коды статусов

Код Описание
in-transit Посылка в пути
out-for-delivery Готовится к доставке
delivered Доставлено
exception Проблема с доставкой

Обработка ошибок

Пример ошибки:

{
  "success": false,
  "error": "Посылка не найдена"
}

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

API использует ограничение частоты запросов для защиты от злоупотреблений.

  • Без API ключа: 10 запросов в минуту с одного IP
  • С API ключом: 100 запросов в минуту

При превышении лимита возвращается HTTP 429 с заголовками:

  • X-RateLimit-Limit - максимальное количество запросов
  • X-RateLimit-Remaining - оставшееся количество запросов
  • X-RateLimit-Reset - время сброса лимита (Unix timestamp)

Ограничения

  • Трек-код должен быть от 4 до 50 символов
  • Кэширование данных: 5 минут
  • Поддержка только GET запросов
  • Все ответы в формате JSON с UTF-8 кодировкой

Нужна помощь с API?

Для получения API ключа или дополнительной информации свяжитесь с нами: