Начало работы
FedEx Developer Portal предлагает набор прикладных программных интерфейсов (API) для интегрирования FedEx в ваши приложения. Приведенные здесь инструкции помогут вам настроить организацию, создать проект, провести проверку интеграции, переместить проект в рабочую среду и проверить API (если потребуется).
Виды пользователей:
FedEx предлагает услуги интеграции трем видам пользователей: отправителям FedEx, проверенным поставщикам решений для программы FedEx Compatible и проверенным интеграторам FedEx.
Отправитель FedEx:
Компания, которая занимается отправкой грузов через FedEx, и ей нужно интегрировать API FedEx в свои приложения.
Решение или поставщик услуг.
Компания, которой требуется интеграция API FedEx для создания решения, приложения или подключаемого модуля, которые в дальнейшем планируется продавать и/или распространить среди внешних организаций, использующих услуги доставки FedEx.
- Поставщик решений для программы FedEx Compatible. Сертифицированная компания, заключившая соглашение в рамках программы FedEx Compatible.
- Интегратор FedEx: проверенная компания с договором в рамках программы интеграторов FedEx.
Выберите подходящий вариант из предложенных ниже. Всем видам пользователей предлагается одни и те же начальные рекомендации.
Выберите чтобы начать работу.
Если у вашей компании нет организации, создайте ее. Можно также присоединиться к существующей организации.
Создание новой организации
На панели навигации выберите пункт «Создать или присоединиться к организации».
Примечание. Создатель организации автоматически назначается ее администратором.
Администраторы могут:
приглашать пользователей;
назначать пользователям роли (например, участник, наблюдатель) и проекты;
управлять учетными записями отправителей.
Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.
В качестве типа компании выберите «Продает или предоставляет программное решение, использующее технологию FedEx, и является проверенным интегратором FedEx».
Укажите название вашей компании, URL-адрес веб-сайта и уникальное название организации. Название организации может совпадать с названием компании или представлять определенную группу (отдел, подразделение, регион, местоположение). Эта информация необходима для подтверждения вашего запроса.
Примечание. Выбирайте название организации, которое будет понятно всем пользователям (например, название компании, отдел, регион, местоположение).
Укажите местоположение вашей компании и место, где будет продаваться или распространяться ваше программное решение.
Добавьте учетную запись плательщика и выполните для нее проверку подлинности.
Примечание. Как поставщик услуг по доставке и логистике в программе интеграторов FedEx вы должны использовать собственный клиентский номер. Вы не можете использовать учетную запись FedEx клиента.
Введите ваш клиентский номер FedEx. Если у вас нет учетной записи FedEx, заведите ее на fedex.com или свяжитесь с представителем службы поддержки FedEx.
Введите псевдоним учетной записи и связанный с ней адрес для выставления счета. Нажмите кнопку «Далее».
Примечание. Адрес для выставления счета должен совпадать с зарегистрированным у нас адресом для этой учетной записи. Это будет учетная запись плательщика по умолчанию для вашей организации.
Чтобы завершить создание организации, необходимо подтвердить подлинность учетной записи. Выберите вариант проверки подлинности (телефон — этот метод доступен только интеграторам в США и Канаде, адрес электронной почты, текстовое сообщение) и нажмите кнопку «Далее».
Получив код для проверки подлинности, введите его и нажмите кнопку «Отправить».
Примите условия
Ознакомьтесь с Глобальным соглашением с интегратором и Руководством по программе. Установите флажки в полях, чтобы подтвердить свое согласие с условиями, и нажмите «Принять».
Появится экран подтверждения. Если нужно отредактировать сведения, выберите команду «Управление организацией».
Пригласить пользователей
Примечание. Приглашать пользователей могут только администраторы.
На панели навигации слева выберите «Управление организацией».
Перейдите на вкладку «Пользователи» и выберите команду «Добавить пользователей».
Заполните форму и назначьте новым пользователям соответствующие роли: наблюдатель, участник или администратор.
Для получения дополнительной информации о ролях пользователей см. Руководстве по администрированию организации.
В раскрывающемся меню «Проекты» назначьте пользователей на проекты (если применимо).
Введите адреса электронной почты каждого пользователя, затем выберите команду «Пригласить».
Присоединение к существующей организации
Запросите приглашение: попросите администратора вашей организации отправить вам приглашение. У вас будет 24 часа, чтобы принять его, прежде чем истечет срок его действия. При необходимости попросите администратора отправить его повторно.
Примите приглашение: войдите в систему, используя ваш существующий идентификатор пользователя и пароль. Если ваш идентификатор уже связан с другой организацией, вам необходимо создать новый.
Присоединение к существующей организации
Этап 1. Попросите администратора прислать вам приглашение.
Если ваша компания уже создала организацию, попросите администратора пригласить вас. Приглашение необходимо будет принять в течение 24 часов, иначе потребуется отправить его повторно.
Этап 2. Примите приглашения.
Чтобы принять приглашение, необходимо войти в систему, указав идентификатор пользователя и пароль или создав новую учетную запись, если ваш идентификатор уже связан с другой организацией.
Создать проект API
Откройте вкладку API на странице Мои проекты. Нажмите кнопку Создать проект API.
Этап 1. Выберите API, которые необходимо включить в проект.
Проверьте квоты API отслеживания, ограничения тарифов и сведения о проверке API.
Этап 2. Настройка сведений о проекте
- Название должно быть уникальным в рамках организации.
- Выберите все страны, в которых планируете осуществлять отправку, и мы назначим вам тестовую учетную запись отправителя. Чтобы протестировать отправку посылок внутри европейской страны, необходима отдельная учетная запись для каждой страны. Добавление и удаление страны доступно в любой момент.
- Чтобы получать уведомления о последних изменениях в API и любых перебоях в обслуживании, необходимо настроить параметры уведомлений.
Этап 3. Прочитайте и примите условия лицензионного соглашения FedEx Developer Portal
Нажмите кнопку «Создать». Откроется экран подтверждения. В только что созданном проекте будут отображаться тестовые учетные данные.
Создание проекта Webhook
Создание корректного 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, и на экране отобразится рабочий секретный ключ. Для обеспечения сохранности секретный ключ отображается только один раз. При утере секретного ключа вы сможете создать новый.
После получения рабочих ключей нажмите Далее. Откроется вкладка Рабочий ключ со сведениями о проекте.
- Для добавления учетных записей отправителей используйте кнопку Изменить, в верхней части таблицы учетных записей отправителей.
Для использования некоторых 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-адрес и тестовые учетные данные рабочими. Повторно протестируйте работу приложения в рабочей среде на образце данных.
Этап 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. Щелкните ссылку Создать секретный ключ под столбцом Секретный ключ.
Теперь можно повторно протестировать приложение в рабочей среде на демонстрационных данных.
Вы можете присоединиться к уже существующей организации, которая соответствует вашей компании, или создать новую.
Создать организацию
На панели навигации выберите пункт «Создать или присоединиться к организации».
Примечание. Создатель организации автоматически назначается ее администратором.
Администраторы могут:
Приглашать пользователей
назначать пользователям роли (например, участник, наблюдатель) и проекты;
управлять учетными записями отправителей.
Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.
В качестве типа компании выберите «Продает или предоставляет программное решение, использующее технологию FedEx, и является проверенным интегратором FedEx».
Укажите название вашей компании, URL-адрес веб-сайта и уникальное название организации. Название организации может совпадать с названием компании или представлять определенную группу (отдел, подразделение, регион, местоположение). Эта информация необходима для подтверждения вашего запроса.
Примечание. Выбирайте название организации, которое будет понятно всем пользователям (например, название компании, отдел, регион, местоположение).
Укажите местоположение вашей компании и место, где будет продаваться или распространяться ваше программное решение.
Добавьте учетную запись плательщика и выполните для нее проверку подлинности.
Примечание. Как поставщик услуг по доставке и логистике в программе интеграторов FedEx вы должны использовать собственный клиентский номер. Вы не можете использовать учетную запись FedEx клиента.
Введите ваш клиентский номер FedEx. Если у вас нет учетной записи FedEx, откройте ее на fedex.com или свяжитесь с представителем службы поддержки FedEx.
Введите псевдоним учетной записи и связанный с ней адрес для выставления счета. Нажмите кнопку «Далее».
Примечание. Адрес для выставления счета должен совпадать с зарегистрированным у нас адресом для этой учетной записи. Это будет учетная запись плательщика по умолчанию для вашей организации.
Чтобы завершить создание организации, необходимо подтвердить подлинность учетной записи. Выберите вариант проверки подлинности (телефон — этот метод доступен только интеграторам в США и Канаде, адрес электронной почты, текстовое сообщение) и нажмите кнопку «Далее».
Получив код для проверки подлинности, введите его и нажмите кнопку «Отправить».
Примите условия
Ознакомьтесь с Соглашением FedEx с интегратором и Руководством по программе. Установите флажки в полях, чтобы подтвердить свое согласие с условиями, и нажмите «Принять».
Появится экран подтверждения. Если нужно отредактировать сведения, выберите команду «Управление организацией».
Пригласить пользователей
Примечание. Приглашать пользователей могут только администраторы.
На панели навигации слева выберите «Управление организацией».
Перейдите на вкладку «Пользователи» и выберите команду «Добавить пользователей».
Заполните форму и назначьте новым пользователям соответствующие роли: наблюдатель, участник или администратор.
Для получения дополнительной информации о ролях пользователей см. Руководстве по администрированию организации.
В раскрывающемся меню «Проекты» назначьте пользователей на проекты (если применимо).
Введите адреса электронной почты каждого пользователя, затем выберите команду «Пригласить».
Присоединение к существующей организации
Запросите приглашение: попросите администратора вашей организации отправить вам приглашение. У вас будет 24 часа, чтобы принять его, прежде чем истечет срок его действия. При необходимости попросите администратора отправить его повторно.
Примите приглашение: войдите в систему, используя ваш существующий идентификатор пользователя и пароль. Если ваш идентификатор уже связан с другой организацией, вам необходимо создать новый.
Создайте проект API
Перейдите на страницу Мои проекты и нажмите кнопку Создать проект.
Заполните поле Название проекта. Рекомендуемый формат названия — «Названиепроекта_названиеприложения». По завершении нажмите кнопку «Далее».
Выберите API и продукты Advanced Integrated Visibility для вашего проекта.
Примечание. Продукты Advanced Integrated Visibility доступны только интеграторам FedEx из США.
Примечание. Если вы выберете какие-либо платные продукты, вам будет предложено назначить учетную запись плательщика для проекта и принять требуемые условия.
Назначьте учетную запись плательщика и примите условия
Назначьте учетную запись плательщика из списка учетных записей, добавленных в организацию. Это действие необходимо, только если вы ранее выбрали платный продукт.
Примите условия и положения, связанные с продуктом.
Подтвердите указанные сведения
Просмотрите выбранные продукты. Проверьте предоставленную учетную запись плательщика.
Прочитайте и примите условия лицензионного соглашения FedEx Developer Portal.
Нажмите кнопку Создать, чтобы сгенерировать ваш проект и просмотреть тестовые учетные данные.
Настройка Advanced Integrated Visibility в проекте
Требования
Создайте действительный URL-адрес обратного вызова в вашем целевом приложении или на платформе — URL-адрес вашего приложения или платформы:
В целях безопасности необходимо использовать протокол HTTPS.
Нельзя включать пространство IP-адресов RFC1918, поддомены fedex.com или прямые IP-адреса (например, 127.0.0.1).
Создайте маркер безопасности
Маркер безопасности должен содержать от 26 до 100 символов и включать:
- 1 прописную букву;
- 1 строчную букву;
- 1 цифру.
Пример. Y1F6OiVUQW2JPSElmRE9U0IY5
Настройте Advanced Integrated Visibility
Выберите Advanced Integrated Visibility. Выберите функции (например,подтверждение доставки, ожидаемая доставка, отслеживание событий и фильтрация по событиям)
Введите целевой URL-адрес и маркер безопасности.
Укажите адрес электронной почты для получения уведомлений об обновлениях и сбоях в работе Advanced Integrated Visibility.
Подтвердите указанные сведения
Прочитайте и примите условия лицензионного соглашения FedEx Developer Portal и формы заказа.
Выберите Создать, чтобы завершить настройку.
Примечание. В зависимости от типа подписки могут потребоваться дополнительные действия. Подробные сведения см. в документации.
Получите тестовые учетные данные и начните тестирование
Ознакомьтесь с документацией по API
- Прочитайте документацию по API, чтобы ознакомиться с различными API, которые мы предлагаем, а также с их бизнес-контекстом и процессами интеграции.
- Скачайте JSON-схему со страницы документации соответствующего API.
- Просмотрите примеры запросов для нужных конечных точек.
Получите тестовые учетные данные
Перейдите на вкладку Ключи API на странице Краткое описание проекта. Ваш ключ API и секретный ключ указаны в заголовке Тестовый ключ.
Ознакомьтесь с документацией по API
- Для всех транзакций API требуется маркер OAuth, срок действия которого составляет один час.
- Ваше приложение должно обновить маркер до истечения срока его действия.
- Подробные сведения см. в документации по API Authorization.
Протестируйте транзакции API в изолированной среде
- Перейдите к нужному API в каталоге API и выберите пункт Документация.
- Выберите нужную конечную точку API в меню слева.
- Используйте образцы запросов, соответствующие вашему варианту использования.
- Внедрите вызовы API, используя ваши тестовые учетные данные и тестовые URL-адреса FedEx.
- Убедитесь, что ответы соответствуют документации.
- Подробную информацию см. в руководстве по виртуализации изолированной среды.
Тестирование Advanced Integrated Visibility
С помощью тестирования Advanced Integrated Visibility можно проверить формат URL-адреса и установить связь между FedEx и вашим приложением.
Тест предоставляет образец тестовых данных для обработки информации об отслеживании.
Примечание. Тестирование не подразумевает проверку подлинности вашего URL-адреса.
Дополнительные сведения см. в документации по Advanced Integrated Visibility.
Для перевода API в рабочую среду требуется проверка. Уровень проверки зависит от конкретного API.
Разработка и тестирование API FedEx
- Используйте ваши тестовые учетные данные (ключ API и секретный ключ) со страницы Краткое описание проекта.
- Определите тестовые сценарии для регионов или территорий, где вы планируете развернуть свое решение (см. Основные тестовые данные для интеграторов).
- Перед запуском тестовых сценариев завершите регистрационные транзакции, используя предоставленные тестовые клиентские номера.
- Выполните все необходимые тестовые сценарии.
Перейдите на страницу Краткое описание проекта.
Выберите пункт Запросить ключи продукта. FedEx получит ваш запрос на получение ключей продукта, и вы будете уведомлены, как только они будут одобрены.
Заполнение формы PIW и сопроводительной записки к проверке
Заполните форму информации о продукте (Product Information Worksheet, PIW) и сопроводительную записку к проверке интегратора, указав свои контактные данные и предполагаемые услуги FedEx.
Отправка итоговых материалов
Соберите указанные ниже материалы и упакуйте их в файл в формате ZIP, чтобы избежать ограничений, налагаемых службой электронной почты. Отправьте материалы на validationmtp@fedex.com.
Необходимые материалы
- Заполненная форма PIW (PDF).
- Заполненная сопроводительная записка к проверке (PDF).
Снимки экрана (PDF):
Решение для обслуживания клиентов, отображающее услуги и особое обращение FedEx
Отказ от обязательств
Лицензионное соглашение конечного пользователя (ЛСКП)
Процесс регистрации конечного пользователя
- Транзакции по регистрации конечных клиентов с использованием многофакторной проверки подлинности (JSON)
- Отсканированные транспортные этикетки для всех применимых тестовых сценариев (PDF/PNG)
- Транзакции отправки с тремя форматами этикеток: PDF, PNG и ZPL (JSON) (для применимых API отправки и оценки)
Лучшие практики по предотвращению задержек
- Этикетки должны быть напечатаны и отсканированы с разрешением не менее 600 DPI.
- Этикетки для термопринтеров должны соответствовать модели принтера (например, ZPLII для принтеров Zebra).
- Для отправлений FedEx International Express® требуется дополнительная этикетка авианакладной (AWB).
- Многоместные отправления (MPS) должны включать этикетку для каждого грузового места.
Оценка этикетки
Команда проверки одобрит или отклонит вашу заявку.
- Если заявка отклонена, внесите исправления и повторно отправьте результат с учетом полученного отзыва.
- В случае одобрения вы получите сообщение электронной почты с подтверждением успешного прохождения проверки. После получения этого сообщения электронной почты ваши рабочие учетные данные будут авторизованы для транзакций с транспортными этикетками.
Следуйте инструкциям после проверки
Просмотрите и выполните все обязательные действия после сертификации (если необходимо).
Как только вы получите уведомление об утверждении ваших рабочих ключей, перейдите на вкладку «Краткое описание проекта» и получите их.
- Скопируйте и надежно сохраните свой рабочий ключ API и секретный ключ.
- Секретный ключ отображается только один раз— в случае его утери нужно будет создать новый.

