Getting started
FedEx Developer Portal предлагает набор прикладных программных интерфейсов (API) для интегрирования FedEx в ваши приложения. Приведенные здесь инструкции помогут вам настроить организацию, создать проект, провести проверку интеграции, переместить проект в рабочую среду и провести сертификацию API (если потребуется).
Виды пользователей:
FedEx предлагает услуги интеграции трем видам пользователей: отправители FedEx, проверенные поставщики решений для программы FedEx Compatible и поставщики, не участвующие в этой программе.
Отправитель FedEx:
Компания, которая занимается отправкой грузов через FedEx, и ей нужно интегрировать API FedEx в свои приложения.
Решение или поставщик услуг.
Компания, которой требуется интеграция API FedEx для создания решения, приложения или плагина, которые в дальнейшем планируется продать или распространить среди внешних организаций, которые используют услуги доставки FedEx. Проверьте, входит ли ваша компания в глобальный каталог сертифицированных поставщиков услуг FedEx.
- Поставщик решений для программы FedEx Compatible. Сертифицированная компания, заключившая соглашение в рамках программы FedEx Compatible.
- Поставщик, не участвующий в программе. Решение или услуга не сертифицированные в рамках программы FedEx Compatible.
Выберите подходящий вариант из предложенных ниже. Всем видам пользователей предлагается одни и те же начальные рекомендации.
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company certified by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- Non-Compatible Provider: Company who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
Prerequisite
You must have a FedEx user ID to log into the FedEx Developer Portal and create an organization.
Вы можете присоединиться к уже существующей организации, которая соответствует вашей компании, или создать новую.
Создать организацию
Чтобы создать собственную организацию, выберите пункт Создать организацию на панели навигации слева. Пользователь, создавший организацию, автоматически становится ее администратором.
- Администратор может приглашать пользователей в организацию, назначать им проекты и роли (например, участник или наблюдатель), а также управлять учетными записями отправителей.
- Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.
Ввод сведений об организации
Укажите название компании, URL-адрес веб-сайта и придумайте название организации. Выберите название, которое будет понятно пользователям. Оно может содержать какие-то конкретные сведения (например, отдел, подразделение, регион, местоположение) или просто совпадать с названием вашей компании.
Поскольку вы являетесь администратором созданной организации, вы можете выбрать пункт Управление организацией на панели навигации слева и добавить сведения о ней.
Добавление учетной записи отправителя
Откройте вкладку Учетные записи отправителей. Нажмите кнопку Добавить учетную запись.
- Укажите свою учетную запись, псевдоним учетной записи и адрес для выставления счетов, связанный с учетной записью. После этого будет проведена проверка адреса для выставления счетов, чтобы убедиться, что он совпадает с указанным в учетной записи и исключить возможность мошенничества. Если у вас нет учетной записи FedEx, создайте новую или свяжитесь с представителем клиента FedEx.
- Затем необходимо принять лицензионное соглашение конечного пользователя или переслать его сотруднику компании, уполномоченному заключать соглашения.
Добавьте учетную запись плательщика
Откройте вкладку Учетные записи плательщиков. Нажмите кнопку Добавить учетную запись плательщика.
- Укажите свою учетную запись, псевдоним учетной записи и адрес в США для выставления счетов, связанный с учетной записью. После этого будет проведена проверка адреса для выставления счетов, чтобы убедиться, что он совпадает с указанным в учетной записи и исключить возможность мошенничества. Если у вас нет учетной записи FedEx, создайте новую или свяжитесь с представителем клиента FedEx. Адрес плательщика должен находиться в США.
- Затем необходимо принять лицензионное соглашение конечного пользователя или переслать его сотруднику компании, уполномоченному заключать соглашения.
Пригласить пользователей
Приглашать пользователей в организацию, а также назначать им роли и проекты может администратор. Откройте вкладку Пользователи. Нажмите кнопку Добавить пользователя.
- Выберите для пользователя одну из ролей: наблюдатель, участник или администратор.
- Существующие проекты необходимо назначить пользователям. Это можно сделать на странице краткого описания любого проекта.
- Укажите в выбранной роли адреса электронной почты пользователей, которых необходимо добавить в организацию.
Присоединение к существующей организации
Этап 1. Попросите администратора прислать вам приглашение.
Если ваша компания уже создала организацию, попросите администратора пригласить вас. Приглашение необходимо будет принять в течение 24 часов, иначе потребуется отправить его повторно.
Этап 2. Примите приглашения.
Чтобы принять приглашение, необходимо войти в систему, указав идентификатор пользователя и пароль или создав новую учетную запись, если ваш идентификатор уже связан с другой организацией.
Создать проект API
Откройте вкладку API на странице Мои проекты. Нажмите кнопку Создать проект API.
Этап 1. Выберите API, которые необходимо включить в проект.
Проверьте квоты API отслеживания, ограничения тарифов и сведения о сертификации API.
Этап 2. Настройка сведений о проекте
- Название должно быть уникальным в рамках организации.
- Выберите все страны, в которых планируете осуществлять отправку, и мы назначим вам тестовую учетную запись отправителя. Чтобы протестировать отправку посылок внутри европейской страны, необходима отдельная учетная запись для каждой страны. Добавление и удаление страны доступно в любой момент.
- Чтобы получать уведомления о последних изменениях в API и любых перебоях в обслуживании, необходимо настроить параметры уведомлений.
Этап 3. Прочитайте и примите условия лицензионного соглашения FedEx Developer Portal
Нажмите кнопку «Создать». Откроется экран подтверждения. В только что созданном проекте будут отображаться тестовые учетные данные.
Создание проекта Webhook
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Advanced Integrated Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
Создание корректного URL-адреса (обратного вызова) в целевом приложении или на платформе
На целевой URL-адрес вы будете получать от FedEx коды аутентификации и сообщения, а также уведомления о полезных данных Webhook отслеживания. Для обеспечения безопасности в URL-адресах необходимо использовать протокол HTTPS. URL-адрес будет заблокирован, если он содержит:
- пространство IP-адресов RFC1918;
- fedex.com или любой поддомен этого сайта.
- IP-адреса (включая localhost, 127.0.0.1).
Создание маркера безопасности
Маркер безопасности может использоваться в качестве секретного ключа для аутентификации и проверки данных, которыми ваша организация обменивается с FedEx. Маркер безопасности должен содержать:
- не менее 26 и не более 100 символов.
- 1 прописная буква;
- 1 строчная буква;
- 1 цифра.
Пример. Y1F6OiVUQW2JPSElmRE9U0IY5
После создания URL-адреса и маркера безопасности вы будете готовы к со зданию проекта Webhook. Откройте вкладку Webhooks на странице Мои проекты. Нажмите кнопку Создать проект Webhook.
Выберите тип подсписки
Отправители FedEx могут сопоставлять события с клиентскими номерами и номерами отслеживания.
Этап 1. Подтверждение учетной записи плательщика и выбор функций
- Проверьте указанный по умолчанию клиентский номер для выставления счетов или выберите другой в рамках организации.
- Настройте проект, выбрав нужные функции (подтверждение доставки, ожидаемая доставка, отслеживание, фильтр событий).
Этап 2. Ввод данных о проекте
- Название должно быть уникальным в рамках организации.
- Укажите целевой URL-адрес и маркер безопасности, созданные на этапе предварительной аутентификации (см. выше).
- Чтобы получать уведомления о последних изменениях в Webhook и любых перебоях в обслуживании, необходимо указать адрес электронной почты и язык уведомлений.
Этап 3. Принятие условий и положений
После того, как вы примете условия лицензионного соглашения с разработчиком FedEx Developer Portal и Формы заказа, и нажмете кнопку «Создать», откроется экран подтверждения.
В зависимости от выбранного типа подписки, могут потребоваться дополнительные действия. Дополнительные сведения см. на странице документации.
Тестовые учетные данные— ключ API, секретный ключ и учетные записи отправителей — находятся на вкладке Тестовый ключ на странице Краткое описание проекта.
Этап 1. Запрос маркера доступа OAuth
Маркер доступа OAuth требуется для каждой транзакции API. Время действия сеанса маркера составляет один час, поэтому в приложении необходимо предусмотреть программное обновление маркера после завершения сеанса. Подробные сведения см. в документации по API Authorization.
Этап 2. Проверка документации по API
Выберите документы для своих API и ознакомьтесь с их деловым контекстом, чтобы получить представление о методах использования выбранного API. Войдите в систему, чтобы скачать коллекцию API JSON, нажав кнопку в верхней части страницы с документацией. Просмотрите примеры запросов для конечной точки, которая соответствует планируемой интеграции.
Этап 3. Проверка шаблонов транзакций в изолированной среде
Чтобы перейти в изолированную среду, выберите на левой панели навигации нужную конечную точку. Найдите подходящие шаблоны запросов и используйте тестовые учетные данные и тестовые URL-адреса FedEx для вызова конечных точек в соответствии с примерами запросов. Убедитесь, что ответы, полученные при вызове API, соответствуют приведенным в документации. Подробные сведения о тестировании см. в руководстве по виртуализации изолированной среды.
Тестирование с функцией Webhook
Тестирование позволяет проверить корректность созданного URL-адреса. При этом FedEx проводит идентификацию URL-адреса и создает подключение для пересылки данных. Кроме того при тестировании вы получаете образец данных отслеживания, передаваемых вашим приложением, и можете проверить метод их обработки. Но тестирование не подразумевает аутентификацию URL-адреса. Дополнительные сведения о тестировании URL-адреса Webhook см. в документации по Webhook.
Перейдите на вкладку Рабочий ключ на странице Краткое описание проекта. Проекты подписки по клиентскому номеру Advanced Integrated Visibility переносить в рабочую среду не нужно.
Этап 1. Настройка проекта
- Переименуйте ключ (если это необходимо).
- Проверка клиентского номера, выбранного на первом этапе создания проекта. Он будет использоваться при переносе проекта в рабочую среду. В рабочей среде в проект можно добавить сколько угодно учетных записей.
Этап 2. Получение ключей проекта
Скопируйте рабочий ключ API, и на экране отобразится рабочий секретный ключ. Для обеспечения сохранности секретный ключ отображается только один раз. При утере секретного ключа вы сможете создать новый.
После получения рабочих ключей нажмите Далее. Откроется вкладка Рабочий ключ со сведениями о проекте.
- Для добавления учетных записей отправителей используйте кнопку Изменить, в верхней части таблицы учетных записей отправителей.
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
Для использования некоторых API в рабочей среде требуется сертификация транспортных этикеток. Узнать, требуется ли вашему API сертификация.
Этап 1. Разработка и тестирование API FedEx в вашем приложении с доступом в Интернет
После завершения разработки приложения с доступом в Интернет необходимо провести проверку тестовых учетных данных (тестовых учетных записей отправителя, ключа API и секретного ключа). Тестовый ключ API и секретный ключ отображаются на странице краткого описания проекта и доступны в любой момент.
Этап 2. Перенос проекта в рабочую среду
После проведения испытаний с API FedEx необходимо приступить к сертификации, переместив ваш проект в рабочую среду на портале FedEx Developer Portal. После успешного завершения данного этапа, вы получите доступ к ключу API и секретному ключу. Просмотреть секретный ключ можно только один раз, но повторное создание секретного ключа доступно неограниченное количество раз.
Этап 3. Заполнение титульного листа этикетки
Заполните титульный лист этикетки контактными данными и укажите, какие услуги планируете реализовать. Укажите номер счета и рабочий ключ.
Этап 4. Создание и отправка тестовых этикеток в группу анализа штрих-кодов
Создайте тестовые этикетки в связанной с приложением тестовой среде FedEx и отправьте их на утверждение в группы оценки этикеток. Срок оценки этикетки группой анализа штрих-кодов составляет три рабочих дня.
Во избежание задержек следуйте нашим рекомендациям.
- Распечатывайте и сканируйте этикетки с разрешением не менее 600 DPI. НЕ ОТПРАВЛЯЙТЕ ФАЙЛЫ, СОЗДАННЫЕ API.
- При использовании термопринтеров необходимо запрашивать тип изображения этикетки, соответствующий модели принтера. Например: ZPLII для принтеров Zebra.
- При создании образцов этикеток, отправляемых на оценку, используйте данные адреса отправителя/получателя. Создавайте образцы этикеток для конкретных услуг, которые вы планируете осуществлять.
- Этикетка FedEx® для оплаты при доставке (C.O.D.) должна также содержать соответствующее значение C.O.D. Этикетка для возврата.
- Отправления FedEx International Express® должны также включать дополнительную этикетку авианакладной (AWB).
- Многоместные грузы должны содержать по одной этикетке на каждую посылку.
- Адрес для отправки файла в формате PDF и титульного листа этикетки: label@fedex.com.
- Распечатанные этикетки следует отправлять на следующий адрес:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Если отсканированные этикетки не имеют видимых дефектов (таких как полосы, пересекающие штрих-код, чернильные пятна или физические повреждения), они пройдут проверку, и вы получите одобрение.
При отправке распечатанных этикеток обратите внимание на качество печати и отсутствие их случайного увеличения или уменьшения масштабирования). Это две основные причины, по которым этикетки не проходят проверку.
Этап 5. Проверка оценки этикеток
Группа анализа штрихкодов проведет оценку полученных тестовых этикеток и утвердит или отклонит их. Затем группа анализа штрихкодов свяжется с вами и сообщит результаты. Если этикетки утверждены, переходите к следующему этапу. Если этикетки не прошли проверку, внесите требуемые изменения и повторно отправьте их на утверждение.
Этап 6. Включение приложения
После утверждения этикеток для использования в рабочей среде группой анализа штрих-кодов, ваши рабочие учетные данные получат разрешение на передачу транспортной этикетки, и вас уведомят по почте об успешном прохождении сертификации. Утверждение производится отдельно для каждого проекта.
Этап 7. Замена URL-адреса и учетных данных
Замените тестовый URL-адрес и тестовые учетные данные рабочими. Повторно протестируйте работу приложения в рабочей среде на образце данных.
Prerequisite
Your business must be an existing FedEx Compatible provider. If your business is not in the Compatible program, then change your selection above to “Non-Compatible Provider.”
Этап 1. Получение приглашения в организацию
FedEx создаст организацию и пригласит одного из сотрудников присоединиться к ней. Этот пользователь получит роль администратора вашей организации.
Этап 2. Принятие приглашения
Чтобы принять приглашение, необходимо войти в систему, указав идентификатор пользователя и пароль или создав новую учетную запись, если ваш идентификатор уже связан с другой организацией.
Этап 3. Приглашение пользователей
Приглашать пользователей в организацию, а также назначать им роли и проекты может администратор. Откройте вкладку «Пользователи». Нажмите кнопку «Добавить пользователя».
- Выберите для пользователя одну из ролей: наблюдатель, участник или администратор. Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.
- Существующие проекты необходимо назначить пользователям. Это можно сделать на странице краткого описания любого проекта.
- Укажите в выбранной роли адреса электронной почты пользователей, которых необходимо добавить в организацию.
Зайдите в Каталог API, чтобы выбрать подходящий для вашего решения API или Webhook. Подобрать API в соответствии с нуждами вашей организации вам помогут консультант по технологиям работы с клиентами FedEx (CTC) и менеджер канала Compatible.
Этап 1. Заполнение формы PIW
Вернитесь на страницу сообщества поставщиков решений для программы FedEx Compatible, чтобы заполнить форму информации о продукте (Product Information Worksheet, PIW).
Этап 2. Проверка проектов, созданных FedEx
FedEx создаст ваши проекты сразу после утверждения формы PIW. Для каждой версии каждого решения на портале FedEx Developer Portal создается отдельный проект.
Этап 3. Просмотр демоверсии API вместе с сотрудниками
Отделы FedEx Compatible, FedEx CTC и отдел сертификации совместно с вашими сотрудниками создают техническую демонстрацию API. Сотрудники FedEx расскажут о сертификации программы Compatible, новых функциях и возможностях API и ответят на ваши вопросы.
Тестовые учетные данные— ключ API и секретный ключ — находятся на вкладке Тестовый ключ на странице Краткое описание проекта.
Этап 1. Создание ключей пользователей
Для создания ключей пользователей требуется API регистрации учетных данных (это закрытый API, который находится внизу раздела Краткое описание проекта API).
Этап 2. Запрос маркера доступа OAuth
Маркер доступа OAuth требуется для каждой транзакции API. Время действия сеанса маркера составляет один час, поэтому в приложении необходимо предусмотреть программное обновление маркера после завершения сеанса. Подробные сведения см. в документации по API Authorization. При просмотре примеров кода не забывайте выбирать Reseller в раскрывающемся списке примеров.
Этап 3. Проверка документации по API
Выберите документы для своих API и ознакомьтесь с их деловым контекстом, чтобы получить представление о методах использования выбранного API. Войдите в систему, чтобы скачать коллекцию API JSON, нажав кнопку в верхней части страницы с документацией. Просмотрите примеры запросов для конечной точки, которая соответствует планируемой интеграции.
Этап 4. Проверка шаблонов транзакций в изолированной среде
Чтобы перейти в изолированную среду, выберите на левой панели навигации нужную конечную точку. Найдите подходящие шаблоны запросов и используйте тестовые учетные данные и тестовые URL-адреса FedEx для вызова конечных точек в соответствии с примерами запросов. Убедитесь, что ответы, полученные при вызове API, соответствуют приведенным в документации. Подробные сведения о тестировании см. в руководстве по виртуализации изолированной среды.
Этап 5. Проверка каждого решения
После завершения полной проверки каждое решение должно пройти сертификацию в Salesforce. FedEx тщательно проверяет все полученные данные и оперативно сообщает о прохождении сертификации.
Тестирование с функцией Webhook
При наличии доступа к функции Webhook тестирование позволяет проверить корректность созданного URL-адреса. При этом FedEx проводит идентификацию URL-адреса и создает подключение для пересылки данных. Кроме того при тестировании вы получаете образец данных отслеживания, передаваемых вашим приложением, и можете проверить метод их обработки. Но тестирование не подразумевает аутентификацию URL-адреса. Дополнительные сведения о тестировании URL-адреса Webhook см. в документации по Webhook.
Затем проект переносится в рабочую среду. Перейдите на вкладку Рабочий ключ на странице Краткое описание проекта API. Щелкните ссылку Создать секретный ключ под столбцом Секретный ключ.
Теперь можно повторно протестировать приложение в рабочей среде на демонстрационных данных.
Prerequisite
You must have a FedEx user ID and account to log into the FedEx Developer Portal and create an organization.
Вы можете присоединиться к уже существующей организации, которая соответствует вашей компании, или создать новую.
Создать организацию
Чтобы создать собственную организацию, выберите пункт Создать организацию на панели навигации слева. Пользователь, создавший организацию, автоматически становится ее администратором.
- Администратор может приглашать пользователей в организацию, назначать им проекты и роли (например, участник или наблюдатель).
- Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.
Этап 1. Ввод сведений об организации
- Укажите название компании, URL-адрес веб-сайта и адрес электронной почты.
- Придумайте название организации. Выберите название, которое будет понятно пользователям. Оно может содержать какие-то конкретные сведения (например, отдел, подразделение, регион, местоположение) или просто совпадать с названием вашей компании.
- Укажите местоположение вашей компании, а также страны или регионы, в которых вы планируете продавать или иным образом распространять свое решение.
Этап 2. Добавление и аутентификация учетной записи
Укажите свою учетную запись, псевдоним учетной записи и адрес для выставления счетов, связанный с учетной записью. После этого будет проведена проверка адреса для выставления счетов, чтобы убедиться, что он совпадает с указанным в учетной записи и исключить возможность мошенничества. Если у вас нет учетной записи FedEx, создайте новую или свяжитесь с представителем клиента FedEx.
- Учетная запись, используемая для первичной регистрации должна принадлежать Интегратору, который участвует в программе FedEx Integrator Program в качестве стороннего поставщика. Не допускается использование учетной записи конечного клиента.
- Это должна быть учетная запись плательщика, используемая вашей организацией по умолчанию.
Этап 3. Принятие условий и положений
После того, как вы примете условия соглашения с разработчиком и руководства по программированию, откроется экран подтверждения. Поскольку вы являетесь администратором созданной организации, вы можете просматривать и редактировать сведения о ней, выбрав пункт Управление организацией на панели навигации слева.
Этап 4. Приглашение пользователей
Приглашать пользователей в организацию, а также назначать им роли и проекты может администратор. Откройте вкладку Пользователи. Нажмите кнопку Добавить пользователя.
- Выберите для пользователя одну из ролей: наблюдатель, участник или администратор.
- Существующие проекты необходимо назначить пользователям. Это можно сделать на странице Краткого описания проекта.
- Укажите в выбранной роли адреса электронной почты пользователей, которых необходимо добавить в организацию.
Присоединение к существующей организации
Этап 1. Попросите администратора прислать вам приглашение.
Если ваша компания уже создала организацию, попросите администратора пригласить вас. Приглашение необходимо будет принять в течение 24 часов, иначе потребуется отправить его повторно.
Этап 2. Примите приглашения.
Чтобы принять приглашение, необходимо войти в систему, указав идентификатор пользователя и пароль или создав новую учетную запись, если ваш идентификатор уже связан с другой организацией.
Откройте вкладку API на странице Мои проекты. Нажмите кнопку Создать проект API.
Этап 1. Выберите API, которые необходимо включить в проект.
Проверьте квоты API отправлений, расчета тарифов, отслеживания, ограничения тарифов и сведения о сертификации API.
- При выборе Ship API или Open Ship API будут автоматически выбраны ключевые для них Service Availability API и Trade Documents Upload API.
Этап 2. Настройка сведений о проекте
Название должно быть уникальным в рамках организации.
Этап 3. Прочитайте и примите условия лицензионного соглашения FedEx Developer Portal
Нажмите кнопку «Создать». Откроется экран подтверждения. В только что созданном проекте будут отображаться тестовые учетные данные.
Создание проекта Webhook
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Shipment Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
Создание корректного URL-адреса (обратного вызова) в целевом приложении или на платформе
На целевой URL-адрес вы будете получать от FedEx коды аутентификации и сообщения, а также уведомления о полезных данных Webhook отслеживания. Для обеспечения безопасности в URL-адресах необходимо использовать протокол HTTPS. URL-адрес будет заблокирован, если он содержит:
- пространство IP-адресов RFC1918;
- fedex.com или любой поддомен этого сайта.
- IP-адреса (включая localhost, 127.0.0.1).
Создание маркера безопасности
Маркер безопасности может использоваться в качестве секретного ключа для аутентификации и проверки данных, которыми ваша организация обменивается с FedEx. Маркер безопасности должен содержать:
- не менее 26 и не более 100 символов.
- 1 прописная буква;
- 1 строчная буква;
- 1 цифра.
Пример. Y1F6OiVUQW2JPSElmRE9U0IY5
После создания URL-адреса и маркера безопасности вы будете готовы к со зданию проекта Webhook. Откройте вкладку Webhooks на странице Мои проекты. Нажмите кнопку Создать проект Webhook.
Выберите тип подсписки
Отправители FedEx могут сопоставлять события с клиентскими номерами и номерами отслеживания.
Этап 1. Подтверждение учетной записи плательщика и выбор функций
- Проверьте указанный по умолчанию клиентский номер для выставления счетов или выберите другой в рамках организации.
- Настройте проект, выбрав нужные функции (подтверждение доставки, ожидаемая доставка, отслеживание, фильтр событий).
Этап 2. Ввод данных о проекте
- Название должно быть уникальным в рамках организации.
- Укажите целевой URL-адрес и маркер безопасности, созданные на этапе предварительной аутентификации (см. выше).
- Чтобы получать уведомления о последних изменениях в Webhook и любых перебоях в обслуживании, необходимо указать адрес электронной почты и язык уведомлений.
Этап 3. Принятие условий и положений
После того, как вы примете условия лицензионного соглашения с разработчиком FedEx Developer Portal и Формы заказа, и нажмете кнопку «Создать», откроется экран подтверждения.
В зависимости от выбранного типа подписки, могут потребоваться дополнительные действия. Дополнительные сведения см. на странице документации.
Тестовые учетные данные— ключ API и секретный ключ — находятся на вкладке Тестовый ключ на странице Краткое описание проекта.
Этап 1. Запрос маркера доступа OAuth
Маркер доступа OAuth требуется для каждой транзакции API. Время действия сеанса маркера составляет один час, поэтому в приложении необходимо предусмотреть программное обновление маркера после завершения сеанса. Подробные сведения см. в документации по API Authorization.
Этап 2. Проверка документации по API
Выберите документы для своих API и ознакомьтесь с их деловым контекстом, чтобы получить представление о методах использования выбранного API. Войдите в систему, чтобы скачать коллекцию API JSON, нажав кнопку в верхней части страницы с документацией. Просмотрите примеры запросов для конечной точки, которая соответствует планируемой интеграции.
Этап 3. Проверка шаблонов транзакций в изолированной среде
Чтобы перейти в изолированную среду, выберите на левой панели навигации нужную конечную точку. Найдите подходящие шаблоны запросов и используйте тестовые учетные данные и тестовые URL-адреса FedEx для вызова конечных точек в соответствии с примерами запросов. Убедитесь, что ответы, полученные при вызове API, соответствуют приведенным в документации. Подробные сведения о тестировании см. в руководстве по виртуализации изолированной среды.
Тестирование с функцией Webhook
При наличии доступа к функции Webhook тестирование позволяет проверить корректность созданного URL-адреса. При этом FedEx проводит идентификацию URL-адреса и создает подключение для пересылки данных. Кроме того при тестировании вы получаете образец данных отслеживания, передаваемых вашим приложением, и можете проверить метод их обработки. Но тестирование не подразумевает аутентификацию URL-адреса. Дополнительные сведения о тестировании URL-адреса Webhook см. в документации по Webhook.
Перейдите на вкладку Рабочий ключ на странице Краткое описание проекта. Проекты подписки по клиентскому номеру Advanced Integrated Visibility переносить в рабочую среду не нужно.
Этап 1. Настройка проекта
Переименуйте ключ (если это необходимо).
Этап 2. Получение ключей проекта
Скопируйте рабочий ключ API, и на экране отобразится рабочий секретный ключ. Для обеспечения сохранности секретный ключ отображается только один раз. При утере секретного ключа вы сможете создать новый.
После получения рабочих ключей нажмите Далее. Откроется вкладка Рабочий ключ со сведениями о проекте.
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
Для использования некоторых API в рабочей среде требуется сертификация транспортных этикеток. Узнать, требуется ли вашему API сертификация.
Этап 1. Разработка и тестирование API FedEx в вашем приложении с доступом в Интернет
После завершения разработки приложения с доступом в Интернет необходимо провести проверку тестовых учетных данных (тестового ключа API и секретного ключа). Тестовый ключ API и секретный ключ отображаются на странице краткого описания проекта и доступны в любой момент.
- Найдите тестовые сценарии, подходящие для регионов или стран, в которых планируется сертификация и развертывание решений. Для этого воспользуйтесь Основными тестовыми данными для интеграторов.
- Перед запуском тестовых сценариев необходимо проверить транзакции регистрации, используя клиентские номера из основных данных.
- Затем выполните запуск всех тестовых сценариев, подходящих для регионов или стран, в которых планируется сертификация и развертывание решений.
Этап 2. Заполнение формы PIW и Сопроводительной записки к проверке
Заполните форму информации о продукте (Product Information Worksheet, PIW) и Сопроводительную записку к проверке, указав контактные данные, а также услуги и возможности, которые планируете реализовать.
Этап 3. Создание и отправка результатов в Группу сертификации
Упакуйте перечисленные ниже формы в ZIP-файл и отправьте на адрес электронной почты validationmtp@fedex.com. Мы рекомендуем пользоваться архиватором ZIP, чтобы исключить риск блокировки сообщения поставщиком услуг электронной почты.
- Заполненные формы PIW для всех указанных стран и регионов (в PDF-формате)
- Заполненная сопроводительная записка к проверке (в PDF-формате)
- Следующие снимки экрана (в PDF-формате):
- Решение для обслуживания клиентов с демонстрацией особого обращения или услуг FedEx
- Отказ от обязательств
- Лицензионное соглашение конечного пользователя (ЛСКП)
- Процесс регистрации конечного пользователя
- Транзакции регистрации конечного пользователя: многофакторная проверка подлинности с возможностью отправки счета-фактуры и ПИН-кода через SMS, звонок или электронное сообщение (в формате файлов JSON запросов и ответов)
- Отсканированные копии распечатанных этикеток для всех тестовых сценариев (из основных тестовых данных) для территорий сертификации решений (PDF или PNG-формат)
- Транзакции отправки трех тестовых сценариев: для каждого формата изображения этикеток: PDF, PNG и ZPL. (в формате файлов JSON запросов и ответов)
Во избежание задержек следуйте нашим рекомендациям.
- Распечатывайте и сканируйте этикетки с разрешением не менее 600 DPI.
- При использовании термопринтеров необходимо запрашивать тип изображения этикетки, соответствующий модели принтера. Например: ZPLII для принтеров Zebra.
- Отправления FedEx International Express® должны также включать дополнительную этикетку авианакладной (AWB).
- Многоместные грузы должны содержать по одной этикетке на каждую посылку.
Этап 4. Проверка оценки этикеток
Группа сертификации проведет оценку полученных от вас данных и утвердит или отклонит их. Затем они свяжутся с вами и сообщат результаты. В случае положительного результата переходите к следующему этапу. Если полученные от вас файлы не прошли проверку, внесите требуемые изменения и повторно отправьте их на утверждение.
Этап 5. Включение приложения
После утверждения всех файлов для использования в рабочей среде группой сертификации, ваши рабочие учетные данные получат разрешение на передачу транспортной этикетки, и вас уведомят по почте об успешном прохождении сертификации. Утверждение производится отдельно для каждого проекта.
Этап 6. Выполнение инструкций после сертификации
Прочитайте инструкции после сертификации и выполните их.
