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


Автоматизируйте отправки с помощью нашего Shipment API

Sender.lv предоставляет комплексный набор API, предназначенных для автоматизации и оптимизации процессов доставки и логистики. Наши API позволяют компаниям эффективно управлять отправлениями, предоставляя доступ к широкому спектру логистических сервисов и возможностей доставки.

Основные возможности:

  • Получение списка доступных стран / направлений: Получите список стран, в которые Sender.lv предоставляет услуги доставки, чтобы убедиться в доступности международных отправлений.
  • Получение тарифов и вариантов доставки: Рассчитайте стоимость доставки и получите доступные варианты доставки для выбранного направления, чтобы выбрать наиболее подходящее решение.
  • Заказ: Адрес → Адрес: Создавайте и управляйте отправлениями от одного физического адреса к другому. Идеально подходит для классической доставки «от двери до двери».
  • Заказ: Адрес → Почтомат: Создавайте отправления с физического адреса в почтомат, предоставляя получателям удобный способ получения посылок.
  • Заказ: Почтомат → Адрес: Организуйте отправку из почтомата на физический адрес, обеспечивая дополнительную гибкость при выборе места отправления и получения.
  • Заказ: Почтомат → Почтомат: Создавайте отправления между почтоматами — это безопасный и удобный способ передачи посылок.
  • Получение заказа по номеру: Получайте подробную информацию о конкретном заказе по его уникальному номеру (Reference), что упрощает отслеживание и управление отправлениями.
  • Получение списка заказов: Получайте полный список ваших заказов для централизованного контроля и управления всеми отправлениями.

Эти API предоставляют компаниям надежные инструменты для эффективного управления логистическими процессами, обеспечивая быстрые, удобные и надежные доставки для ваших клиентов.

Дополнительные возможности:

  • Получение доступных дат и времени забора для каждого перевозчика: Больше не нужно гадать — просто выберите наиболее подходящее время забора из списка, который предоставляет API.
  • Получение ближайших почтоматов для любого адреса: API автоматически определяет 10 ближайших почтоматов для указанного адреса доставки. Это избавляет от необходимости самостоятельно искать почтоматы или показывать клиенту длинный список всех доступных пунктов.
  • Получение транспортных этикеток через Callback URL: После обработки заказа транспортные этикетки автоматически отправляются на ваш Callback URL. Эта функция позволяет избежать длительного ожидания ответа сервера и исключает необходимость постоянно отправлять повторные запросы для проверки готовности этикеток.


Портал разработчика / Документация: https://dev.shipmentapi.com/en


Начало работы с Sender API

Перед тем как начать использовать Sender API, необходимо создать учетную запись в системе Sender.lv.

  • Создайте учетную запись на нашем портале доставки: https://new.sender.lv
  • Завершите регистрацию, указав адрес электронной почты и номер телефона. При регистрации вы можете выбрать тип учетной записи — частное лицо или юридическое лицо.
  • Сообщите нам адрес электронной почты, который вы использовали при регистрации. Мы активируем вашу учетную запись для работы с API.
  • После активации вы сможете получить API-ключи и приступить к тестированию интеграции.


Создание адреса отправителя по умолчанию

После регистрации и входа в систему перейдите в раздел: Мой аккаунт → Адресная книга

Создайте адрес отправителя по умолчанию для вашего склада, офиса или интернет-магазина. Этот адрес будет использоваться в качестве стандартного адреса забора отправлений курьером, а также как адрес возврата для недоставленных посылок.

Хотя API позволяет указывать разные адреса отправителя для отдельных отправлений, создание адреса отправителя по умолчанию является обязательным условием для начала работы с API.


Создание API-интеграции

Перейдите в раздел: Мой аккаунт → Настройки → Интеграции / API

Здесь вы можете создать новую API-интеграцию и получить API-ключи, необходимые для подключения к Sender.lv API.

Заполните форму интеграции:

  • Название — название вашей интеграции (например, название интернет-магазина или приложения).
  • Тип — выберите Custom API Integration.
  • URL — полный URL вашего сайта или приложения (включая https://).
  • Statuses URL (необязательно) — адрес вашего webhook, на который будут отправляться обновления статусов отправлений.
  • X-Senderise-Api-Code — секретный ключ, сгенерированный вашим приложением. Он используется для проверки подлинности запросов между вашей системой и Sender.lv.
  • Адрес склада — выберите адрес отправителя по умолчанию, созданный на предыдущем этапе.

Нажмите Save, чтобы создать интеграцию. После этого будут автоматически сгенерированы API-ключи, которые можно использовать в вашем приложении.



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

Полная документация по API доступна по адресу: https://dev.shipmentapi.com

  • Зарегистрируйтесь на нашем портале разработчика: https://dev.shipmentapi.com/en/client/register
  • На портале разработчика подключите ваш Sandbox-аккаунт Sender.lv: Account → My Sandboxes (меню в правом верхнем углу).
  • Во время разработки и тестирования используйте исключительно Sandbox API Key.
  • Тестируйте API-запросы в режиме реального времени и изучайте различные сценарии работы API в одном месте: API Reference.
  • После успешного завершения тестирования в Sandbox просто замените Sandbox API Key на Production API Key.

Какие требования предъявляются к API-клиенту?

Sender.lv серьезно относится к безопасности ваших данных и данных ваших клиентов. Перед началом работы с API убедитесь, что ваш HTTP-клиент поддерживает следующие протоколы и требования безопасности.

  • HTTPS (TLS)
  • Сертификаты. Наш SSL-сертификат подписан Google Trust Services. Большинство современных операционных систем и HTTP-клиентов автоматически доверяют этим сертификатам. Если ваша система не поддерживает автоматическую проверку, необходимо добавить Google Trust Root Certificate в список доверенных центров сертификации (CA). Обратите внимание, что серверный сертификат Sender API регулярно обновляется, поэтому закрепление (certificate pinning) конкретного сертификата не рекомендуется.
  • Версия HTTP. Sender API поддерживает HTTP/1.1 и HTTP/2. Поддержка HTTP/3 в настоящее время отсутствует. HTTP/1.0 не поддерживается.
  • GET-запросы с телом (Body). Sender API не поддерживает GET-запросы, содержащие тело запроса. При попытке отправить такой запрос сервер вернет ошибку 403 Forbidden.
  • IP-версия. В настоящее время API доступен только по IPv4.

Существуют ли ограничения на количество API-запросов?

Для обеспечения стабильной работы платформы, справедливого использования ресурсов и защиты API от перегрузок применяются стандартные ограничения на количество запросов (Rate Limits).

По умолчанию действуют следующие лимиты:

  • Безопасные запросы (GET): до 60 запросов в минуту.
  • При превышении лимита в 60 запросов доступ к API будет автоматически заблокирован на 1 минуту.

Если вашему приложению требуется более высокий лимит запросов, пожалуйста, свяжитесь с нами — мы сможем увеличить его индивидуально.


Как выполнять аутентификацию API-запросов?

  • После получения Sandbox или Production API Key добавьте его в HTTP-заголовок x-api-key.
  • Ниже приведен пример аутентификации запроса к Sender API с использованием curl:

curl --location 'https://api.sender.lv/api/sandbox/v1/orders' \
--header 'Accept: application/json' \
--header 'x-api-key: 239uw87yhuih87sdf<based-64-encoded-token>'



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

Мы всегда готовы помочь вам с любыми вопросами, связанными с интеграцией Sender API, а также ответить на любые другие технические вопросы.