1. Создайте проект, чтобы получить учетные данные.
2. Внедрите API в приложение и протестируйте его.
3. Перенесите проект в рабочую среду.
4. Завершите сертификацию.

Для создания проекта API достаточно, чтобы администратор или участник организации нажал кнопку Создать проект API.

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

Если вы выступаете в роли отправителя, можете приступать к созданию проекта. Этот процесс состоит из трех этапов.

Выберите API

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

Для API отслеживания понадобится

• выбрать клиентский номер, который будет связан с ключом продукта;
• проверить квоты API отслеживания, ограничения тарифов и сведения о сертификации API;
• согласиться (или отказаться) получать сообщения о превышении квот на транзакции.

Настроить проект

Укажите сведения о проекте, в том числе название и место отправки.

• Название должно быть уникальным в рамках организации.
• Выберите все страны, в которых планируете осуществлять отправку, и мы назначим вам тестовую учетную запись отправителя. Чтобы протестировать отправку посылок внутри европейской страны, необходима отдельная учетная запись для каждой страны. Добавление и удаление страны доступно в любой момент.
• Чтобы получать уведомления о последних изменениях в API и любых перебоях в обслуживании, необходимо настроить параметры уведомлений.

Подтверждение указанных сведений

Проверьте сведения о проекте и подтвердите свое согласие с Условиями и положениями.

• Прочитайте и примите условия лицензионного соглашения для портала FedEx Developer Portal и подтвердите, что не планируете продавать или распространять свое приложение.
• Нажмите кнопку «Создать». Откроется экран подтверждения. В только что созданном проекте будут отображаться тестовые учетные данные.

• Запросите маркер доступа OAuth, который должен использоваться с каждой транзакцией API. Время действия сеанса маркера составляет один час, поэтому в приложении необходимо предусмотреть программное обновление маркера после завершения сеанса. Подробные сведения см. в документации по API авторизации.
• Выберите документы для своих API и ознакомьтесь с их деловым контекстом, чтобы получить представление о методах использования выбранного API. Просмотрите примеры запросов для конечной точки, которая соответствует планируемой интеграции.
• Выполните вызовы конечных точек в соответствии с примерами запросов, указав тестовые учетные данные.
• Убедитесь, что ответы, полученные при вызове API, соответствуют приведенным в документации.
• Проведите полную проверку работы приложения в тестовой среде FedEx с указанием тестовых учетных данных и тестовых URL-адресов FedEx.

Настройка проекта включает указанные ниже действия.

• Переименование ключа (если это необходимо).
• Проверка клиентского номера, выбранного на первом этапе создания проекта. Он будет использоваться при переносе проекта в рабочую среду. В рабочей среде в проект можно добавить сколько угодно учетных записей.

Получение ключей проекта

• На экране отобразится рабочий ключ API и рабочий секретный ключ. Скопируйте их в надежное место.
• Для обеспечения сохранности секретный ключ отображается только один раз. При утере секретного ключа вы сможете создать новый.
• Нажмите кнопку Далее.

После этого вы вернетесь на страницу Краткое описание проекта. Здесь вы можете добавить в проект другие учетные записи.

На странице Краткое описание проекта доступны следующие возможности.

• Чтобы добавить учетные записи в проект, щелкните по значку с тремя вертикальными точками.
• Затем нажмите Изменить.

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

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

1. После сертификации и включения всех API обновите запросы API, заменив тестовые URI, ключи и учетные записи отправителей на рабочие.

2. Повторно протестируйте работу приложения в рабочей среде на образце данных.

3. Пользуйтесь всеми преимуществами новой интеграции!

Предварительные требования для создания проекта Webhook

1. Создание корректного URL-адреса в целевом приложении или на платформе
2. Создание маркера безопасности
3. Тестирование URL-адреса Webhook
4. Проверка целевого URL-адреса

Создание проекта Webhook

1. Чтобы получать настроенные уведомления с полезными сведениями, необходимо создать проект Webhook.

Предварительные требования для создания проекта Webhook

Создайте корректный URL-адрес в приложении или платформе, чтобы получать сообщения и коды аутентификации, а также уведомления Webhook отслеживания от FedEx.

Требования к URL-адресу

Маркер безопасности может использоваться как секретный ключ для аутентификации и проверки при обмене данными с FedEx.

Требования к маркеру безопасности:

• не менее 25 и не более 100 символов;
• 1 прописная буква;
• 1 строчная буква;
• 1 цифра

Тестирование URL-адреса — не обязательный, но рекомендуемый этап.

Тестирование позволяет проверить корректность URL-адреса, созданного на первом этапе. При этом FedEx проводит идентификацию URL-адреса и создает подключение для пересылки данных. Кроме того при тестировании вы получаете образец данных отслеживания, передаваемых вашим приложением, и можете проверить метод их обработки. Но тестирование не подразумевает аутентификацию URL-адреса.

Дополнительные сведения о тестировании URL-адреса Webhook см. в документации по Webhook.

Метод проверки подлинности сообщений с помощью алгоритма HMAC-SHA256 позволяет настроить процесс аутентификации данных, которыми FedEx обменивается с целевым URL-адресом.

1. После того как вы нажмете кнопку Создать, FedEx создаст произвольную контрольную фразу и отправит ее вам в теле запроса. Вы в свою очередь должны передать эту контрольную фразу обратно FedEx в теле ответа.

1. Для этого инициализируйте код аутентификации сообщения (MAC) c использованием алгоритма HMAC-SHA256, чтобы сформировать хеш (или комбинацию) контрольной фразы и маркера безопасности (или секретного ключа) и создать подпись хеша.

1. Тело ответа должно содержать challengeString и challengeStringResponse, а также код состояния HTTP 200 (ОК) или 202 (ACCEPTED).

1. FedEx проверит контрольную фразу и ответ на нее.

• После получения тела ответа FedEx проведет проверку challengeString и challengeStringResponse (или созданной ранее подписи на основе хеширования), сравнив их с challengeString и подписью, созданной FedEx, соответственно.

• Если challengeString и подписи HMAC совпадают, проверка и процесс обработки считаются успешными. В противном случае появится сообщение об ошибке в ходе проверки.

Создание проекта Webhook

Откройте вкладку Webhook на странице Мои проекты.

Для создания проекта Webhook достаточно, чтобы администратор или участник организации нажал кнопку Создать Webhook.

Но сначала вы должны рассказать, для чего вам нужен доступ к Webhook FedEx. Откроется модальное окно с раскрывающимся списком вариантов. Выберите тот из них, который лучше всего отражает потребность вашего предприятия в интеграции с Webhook FedEx.

Если вы выступаете в роли отправителя, можете приступать к созданию проекта. Этот процесс состоит из описанных далее этапов.

1. Определение потребностей предприятия

• Выберите вариант, который лучше всего обосновывает необходимость интеграции с Webhook FedEx.

1. Выбор уровня и его функций

• Выберите базовый или расширенный вариант Webhook в соответствии с вашими потребностями.
• Впоследствии выбранный уровень можно будет изменить.
• Для каждого уровня существует свой тариф ежемесячной подписки.

• Выберите функции, которые необходимо настроить для вашего проекта.
• Набор функций также можно будет изменить позднее.

1. Настройка сведений о проекте

• Дайте проекту уникальное название.
• Укажите целевой URL-адрес и маркер безопасности, созданные на этапе предварительной аутентификации.

Выбор учетных записей

• Выберите учетные записи из списка доступных (из США и Канады), которые будут связаны с вашим проектом.

  5. Подтверждение сведений и принятие условий

• Проверьте настройки проекта.
• Прочитайте и примите условия лицензионного соглашения для портала Developer Portal и подтвердите, что не планируете распространять свое приложение.
• Прочитайте и подтвердите принятие ценового соглашения FedEx.
• Нажмите кнопку Создать проект.

1. В случае успешной проверки запроса на создание проекта откроется экран подтверждения.

• Если проект не прошел проверку, появится сообщение об ошибке.

1. Затем система присвоит проекту отслеживания идентификатор Webhook и статус «Активный».

1. Создание в FedEx организации поставщика решений для программы Compatible.
2. Примите приглашение.
3. Пригласите пользователей в организацию.
4. Выберите API, необходимые для вашего решения.
5. FedEx создает проект(ы).
6. Интегрируйте API в приложение и пройдите сертификацию программы Compatible.
7. FedEx переносит проекты в рабочую среду.
8. Создайте рабочий секретный ключ.

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

• Чтобы получить доступ к документации и артефактам интеграции API, необходимо принять приглашение. Чтобы принять приглашение, войдите в систему, указав идентификатор пользователя FedEx и пароль или создав новую учетную запись, если у вас нет учетных данных.

• Администратор может приглашать любых участников, которым необходим доступ к проекту или организации. Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.

• Если организация уже создана, попросите администратора организации пригласить вас или обратитесь в FedEx за приглашением. Необходимо принять приглашение в течение 24 часов, иначе потребуется отправить приглашение повторно.

• Зайдите в Каталог API, чтобы выбрать API, которые подходят для вашего решения. Консультант по технологиям работы с клиентами FedEx (CTC) и менеджер канала Compatible помогут вам подобрать API в соответствии с нуждами вашей организации.

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

• Просмотрите документацию на API и ознакомьтесь подробнее с элементами запросов и ответов, примерами на выбранном языке программирования, объектами ошибок и т. д.

• Вернитесь в Salesforce, чтобы заполнить форму информации о продукте (Product Information Worksheet, PIW) и составить список API, которые нужно добавить в ваше приложение.

FedEx создаст ваши проекты сразу после утверждения формы PIW. Для каждой версии каждого решения на портале FedEx Developer Portal создается отдельный проект. Для просмотра каждого из проектов обычному пользователю (в отличие от администратора организации) необходимо получить приглашение. 

После этого отделы FedEx Compatible, FedEx CTC и отдел сертификации совместно с вашими сотрудниками создают техническую демонстрацию API. Команда FedEx обсуждает новые функции и возможности, предоставляемые выбранными версиями API. Команда поможет решить технические вопросы, касающиеся API, их тестирования и всех процессов, требуемых для начала процесса сертификации* API.

* Сертификация — процедура программы FedEx Compatible, направленная на обеспечение соответствия требованиям программы. Сертификация программы Compatible необходима для того, чтобы все поставщики решений в рамках программы FedEx Compatible выполняли требования технологических стандартов и стандартов обслуживания FedEx в ходе внедрения, продвижения и распространения технологий FedEx среди грузоперевозчиков (заказчиков).

1. После этого вы получите доступ к тестовому ключу API и тестовому секретному ключу для запуска транзакций. Ключи находятся на вкладке «Тестовый ключ» на странице «Краткое описание проекта».

1. Для создания ключей пользователей требуется API регистрации с использованием учетных данных (это закрытый API, который находится в разделе API каждого проекта).
2. После создания нескольких ключей пользователей запросите маркер доступа OAuth, который должен использоваться с каждой транзакцией API. Время действия сеанса маркера составляет один час, поэтому в приложении необходимо предусмотреть программное обновление маркера до истечения срока действия сеанса. Подробные сведения см. в документации по авторизации API. При просмотре примеров кода не забывайте выбирать Reseller в раскрывающемся списке примеров.

1. Выберите документацию для соответствующего API на странице тестовых ключей и ознакомьтесь с бизнес-контекстом, чтобы получить представление о методах использования выбранного API. Просмотрите примеры запросов для конечной точки, которая соответствует планируемой интеграции.
2. Реализуйте вызовы конечных точек в соответствии с примерами запросов и укажите тестовые учетные данные.
3. Убедитесь, что ответы, полученные при вызове API, соответствуют приведенным в документации.
4. Проведите полную проверку работы приложения в тестовой среде FedEx с указанием тестовых учетных данных и тестовых URI FedEx.
5. После завершения полной проверки каждое решение должно пройти сертификацию в Salesforce. FedEx тщательно проверяет все полученные данные и оперативно сообщает о прохождении сертификации.

• Затем проект переносится в рабочую среду.
• После этого на вкладке «Рабочий ключ» на странице «Краткое описание проекта» появится рабочий ключ API.

• Для создания рабочего секретного ключа щелкните ссылку Создать секретный ключ под столбцом Секретный ключ.
• Теперь можно повторно протестировать приложение в рабочей среде на демонстрационных данных.
• Пользуйтесь всеми преимуществами новой интеграции!