Выдача ключей доступа к API

From PonyExpress API Wiki
Jump to: navigation, search

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

Ключ доступа можно получить, заполнив форму по адресу https://api.p2e.ru/Key/Connect
Данную форму может заполнить клиент, а может за клиента это сделать менеджер PonyExpress.
На форме есть краткое описание этапов получения ключа доступа.
На форме необходимо заполнить следующие параметры:

  • название организации (данные клиента)
  • номер договора (данные клиента) в формате XX-YYYY
  • email клиента (обязательно задавать реальный адрес)
  • email менеджера PonyExpress (обязательно задавать реальный адрес)
  • выбрать тип интеграции

Поля обозначенные * обязательны для заполнения.

Проверка номера договора

Важно правильно вводить номер договора. Сначала префикс из 2-х цифр, затем основной номер, состоящий из 4-х цифр.
В случае, если номер договора введен неверно или такого контракта не найдена в ИС PonyExpress, то на форме будет выведено следующее сообщение:

ContractNumberWrong.png

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

Email клиента и менеджера

Emai клиента – обязательное поле. На email клиента отправится ключ с тестовым ключом, а затем промышленный ключ. Этапы подтверждения заявки на выдачу ключа будут описаны ниже.
Email менеджера - обязательное поле. На email менеджера отправится письмо со ссылкой на форму генерации тестового и боевого ключей. Валидным считается email, содержащий слово “pony” после символа @. test@ponyexpress.ru или test@pony-spb.ru – валидные адреса, pony@test.ru – нет.

Тип интеграции

Типы стандартных интеграций:

  • Интернет магазин
  • Обычная доставка
  • Только калькуляция

В случае нестандартной интеграции необходимо нажать “Другое” и выбрать необходимый функционал.
Пример заполнения формы:

CustomIntegrationForm.png

Отправка запроса и выдача тестового ключа

После того как пользователь нажмет на кнопку “Отправить запрос”, в системе зарегистрируется заявка, на email клиента уйдет сообщение с номером заявки

EmailOfGrandTestKey.png

На email менеджера уйдет письмо с ссылкой на форму генерации ключей.
Содержание письма:
Здравствуйте! Клиент ООО "Тестовая компания"/12-6590 сформировал новый запрос на выдачу тестового ключа доступа. Необходимо подтвердить или отклонить заявку на выдачу тестового ключа доступа по ссылке: https://api.p2e.ru/Key/Requests?id=65&hashCode=1873126710. Менеджер должен перейти по ссылке. Откроется следующая форма:

ListOfGrandKeysForm.png

Менеджер или подтверждает (если все указано верно) заявку (ссылка “Approve”) или отклоняет (ссылка “Decline”).
Для типов интеграций “Интернет магазин”, “Обычная доставка”, “Другое” после подтверждения отправляется ссылка на тестовый ключ.
Для типа интеграции “Только калькуляция” после подтверждения отправляется ссылка на промышленный ключ.
После подтверждения на email клиента уйдет сгенерированный тестовый ключ.

GeneratedTestKey.png

Выдача промышленного ключа

После того как будет проведено тестирование с клиентом, необходимо заново открыть форму по ссылке, высланную раннее https://api.p2e.ru/Key/Requests?id=65&hashCode=1873126710 и сгенерировать промышленный ключ.
Созданный промышленный ключ менеджер может увидеть в открывшейся форме:

ListOfGrandProdKeysForm.png

Ключ автоматически отправится клиенту по email:

EmailOfGrandProdKey.png