Общее описание API

From PonyExpress API Wiki
Jump to: navigation, search

Общее

Для интеграции с PonyExpress можно использовать стандартный API компании, который позволяет:

  • передавать информацию по заказам;
  • рассчитывать стоимость доставки;
  • отслеживать отправления.
  • печатать накладные/наклейки
  • выполнять другие специфические для конкретных типов интеграций запросы.

Взаимодействие происходит по протоколу SOAP, посредством передачи запросов в формате Xml. Адрес интеграционного приложения: https://api.p2e.ru

Начало интеграции

Для начала интеграции с API PonyExpress необходимо клиенту получить тестовый ключ для интеграции.
Для получения тестового ключа необходимо перейти на страницу https://api.p2e.ru/Key/Connect и следовать инструкциям.

Валидация запросов

Все xml- запросы проходят xsd-валидацию на корректность введенных данных.
Xsd-схемы могут отличаться для разных ключей.
Проверить xsd-схемы для своего ключа можно по ссылке http://api.p2e.ru/Documentation.
Смотрите в самом низу раздел Allowed XSD schemas.

Продолжение интеграции

После окончания тестирования клиенту необходимо получить промышленный ключ.
Категория ключа должна быть такой же как и ранее выданного тестового ключа.
Для выдачи промышленного ключа необходимо обратиться к менеджеру PonyExpress.

Если у клиента есть вопросы

Если в процессе интеграции у клиента возникают вопросы, то клиент их может задавать менеджеру PonyExpress или создавать заявку на helpdesk@ponyexpress.ru. В случае создания заявки необходимо указывать:

  • в теме: API. Название клиента. Кратко суть вопроса
  • в теле : Описание вопросы/проблемы. Прикладывая номер заказа Пегаса или клиентский номер заказа. Или XML заказа, если есть вопросы по тегам.​

Техническое описание API

Для интеграции с информационной системой Пони Экспресс есть универсальный сервис.
Есть возможность подключиться через WCF-сервис https://svc-api.p2e.ru/UI_Service.svc?singleWsdl , либо через asmx-сервис https://svc-api.p2e.ru/UI_Service.asmx?WSDL .
Предпочтительнее осуществлять подключение через WCF-сервис, так как asmx-сервис служит для обратной совместимости и развитие данной технологии прекращена компанией Microsoft.
В правила FireWall клиенту необходимо внести внешний IP-адрес сервиса - 91.206.216.32 или весь список адресов подсети 91.206.216.0/32.
Взаимодействие с сервисом осуществляется по протоколу SOAP.
Для тестирования в ручном режиме можно использовать веб-форму по адресу https://api.p2e.ru/Request.
Веб-сервис имеет всего один метод: SubmitRequest. На вход необходимо передать 2 параметра:

  • accesskey – ключ доступа партнера к универсальному интерфейсу Пони Экспресс;
  • requestBody – строка XML, описывающая запрос.

В ответ метод возвращает другую строку XML, которая содержит заказы и их статусы.