Интегратор FedEx
Требования
Чтобы начать работу с FedEx Developer Portal и создать организацию, необходим идентификатор пользователя FedEx.
Присоединитесь к организации вашей компании, чтобы начать совместную работу с коллегами. Если у вашей компании нет организации, вы можете ее создать.
Присоединение к существующей организации
1. Запросите приглашение
Попросите администратора вашей организации отправить вам приглашение. У вас будет 24 часа, чтобы принять его. Если срок действия приглашения истек, попросите администратора отправить его повторно.
2. Примите приглашение.
Войдите в систему, используя ваш существующий идентификатор пользователя и пароль. Если ваш идентификатор уже связан с другой организацией, вам необходимо создать новый.
Создание новой организации
Создав организацию, вы становитесь ее администратором. Администратор может приглашать пользователей в организацию, назначать им роли и проекты, а также управлять учетными записями плательщиков.
Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.
1. В панели навигации нажмите Создать организацию или присоединиться к существующей.
2. Введите указанные ниже данные.
- Для пункта Я работаю в компании, которая выберите Продает или предоставляет программное решение, использующее технологию FedEx, и хотела бы зарегистрироваться в качестве проверенного интегратора FedEx .
- Введите название компании, ее сайт и название организации, которое будет понятно вашей команде, например название отдела, подразделения или региона.
- Введите официальный адрес электронной почты, в котором указаны домен вашей компании, страна или территория, где она зарегистрирована, а также страны и территории, где вы продаете или распространяете свое программное решение.
3. Нажмите Далее.
Изменить или добавить сведения можно позже в разделе Управление организацией.
Добавление учетной записи плательщика
1. Откройте вкладку Учетные записи плательщиков. Если у вас нет учетной записи плательщика FedEx, нажмите Создать учетную запись плательщика или обратитесь в службу поддержки клиентов FedEx.
Примечание. Используйте свой клиентский номер FedEx, а не принадлежащий клиенту.
2. Выберите Добавить учетную запись плательщика.
3. Укажите свою учетную запись, псевдоним учетной записи и адрес для выставления счетов в США, который вы использовали при создании учетной записи.
Примечание. Адрес для выставления счета должен совпадать с адресом, который вы использовали при настройке учетной записи. Эта учетная запись станет учетной записью плательщика по умолчанию для вашей организации.
4. Выберите способ аутентификации.
- Звонки по телефону доступны только для интеграторов в США и Канаде.
5. Введите полученный код аутентификации и нажмите Отправить.
6. Прочитайте и примите условия Соглашение FedEx с интегратором.
Приглашение пользователей от имени администратора
1. Перейдите в раздел Управление организацией и выберите вкладку Пользователи.
2. Выберите + Добавить пользователей.
3. Введите указанные ниже данные.
- Страна или регион.
- Предпочитаемый язык.
4. Выберите роль пользователя (наблюдатель, участник или администратор).
5. (Не обязательно) Назначьте пользователю проект.
- Вы можете назначить пользователей в любой момент на странице Обзор проекта.
6. Укажите адреса электронной почты пользователей и нажмите Пригласить.
- Можно приглашать до 20 пользователей одновременно, при этом адреса электронной почты должны быть разделены запятыми. Приглашение действует в течение 24 часов.
Создание проекта
1. Перейдите в раздел Мои проекты и выберите + Создать проект.
2. Введите название проекта.
- Рекомендуемый формат названия — Названиепроекта_названиеприложения. По завершении нажмите Далее.
3. Выберите API и продукты Advanced Integrated Visibility для вашего проекта.
- Продукты Advanced Integrated Visibility доступны только интеграторам FedEx из США.
- Если вы выберете какие-либо платные продукты, вам будет предложено назначить учетную запись плательщика для проекта и принять требуемые условия.
Назначение учетной записи плательщика
Примечание. Это требуется только в том случае, если вы выбираете платный продукт.
1. Назначьте учетную запись плательщика из списка учетных записей, добавленных в организацию. Учетная запись плательщика должна быть зарегистрирована в США.
2. Примите условия лицензионного соглашения FedEx Developer Portal и формы заказа, а затем нажмите кнопку Создать.
Настройка Advanced Integrated Visibility в проекте
Требования
- Ознакомьтесь с тарифами: ежемесячная плата подписчиков зависит от количества номеров отслеживания. Подробные сведения о ценах см. в форме заказа.
- Настройте учетные записи: для webhook отображения отправления требуется зарегистрированная в США учетная запись плательщика и по крайней мере одна учетная запись отправителя. Эти учетные записи являются взаимоисключающими. Добавить их могут только администраторы на странице Управление организацией.
1. Создайте целевой URL-адрес в приложении или на платформе для получения обратных вызовов. URL-адреса должны:
- использовать протокол HTTPS;
- исключать пространство IP-адресов RFC1918, fedex.com и его поддомены, а также такие IP-адреса, как localhost или 127.0.0.1.
2. Создайте маркер безопасности для аутентификации. Правила для маркера:
- маркер должен содержать 26–100 символов, в том числе хотя бы одну заглавную букву, хотя бы одну строчную букву и хотя бы одну цифру.
3. В меню выберите Мои проекты, затем откройте вкладку Advanced Integrated Visibility.
4. Выберите Создать проект Advanced Integrated Visibility.
5. Выберите тип пользователя.
- Отправитель FedEx: компания, которая занимается отправкой грузов через FedEx, и ей нужно интегрировать API FedEx в свои приложения.
- Поставщик решений для программы FedEx Compatible: компания, которая является сертифицированным поставщиком решений для программы FedEx Compatible.
- Интегратор FedEx: компания, которая продает программный продукт, использующий технологию FedEx, и является проверенным интегратором FedEx.
6. Выберите тип подсписки. Вы можете подписаться на события по клиентским номерам и номерам отслеживания.
7. Подтвердите учетную запись плательщика и выберите нужные вам функции, например подтверждение доставки, ожидаемая доставка, события отслеживания или фильтрация по событиям.
8. Введите сведения о проекте.
- Введите уникальное и легко узнаваемое название проекта.
- Введите целевой URL-адрес и маркер безопасности.
- Введите адрес электронной почты и предпочитаемый язык для получения уведомлений об обновлениях и сбоях в работе Advanced Integrated Visibility.
9. Примите условия лицензионного соглашения FedEx Developer Portal и формы заказа, а затем нажмите Создать.
Примечание. В зависимости от выбранного типа подписки могут потребоваться дополнительные действия. Подробные сведения см. в документации по webhook.
Выполните эти действия, чтобы проверить интеграцию API и убедиться, что ваше приложение может отправлять и получать тестовые данные.
1. В меню выберите Мои проекты, а затем — Название проекта.
2. На вкладке Ключи API в разделе Тестовый ключ найдите тестовые учетные данные.
3. Войдите в систему и скачайте коллекцию API JSON, нажав кнопку Загрузить схему JSON в верхней части страницы документации. Просмотрите примеры запросов для конечных точек, которые используются в вашей интеграции.
4. Запросите маркер доступа OAuth, который должен использоваться с каждой транзакцией API. Маркер действителен в течение часа. Вы можете настроить приложение, чтобы маркер обновлялся до истечения этого срока. Для получения подробной информации см. документацию по API Authorization.
5. В меню нажмите Каталог API, выберите API, с которым хотите работать, и нажмите Документация.
6. В меню выберите конечную точку.
7. Отправьте образцы запросов, указав тестовые учетные данные и тестовый URL-адрес FedEx, а затем убедитесь, что ответы соответствуют примерам из документации. Для получения подробной информации см. Руководство по виртуализации изолированной среды.
8. Выполните тестирование с помощью Advanced Integrated Visibility, чтобы создать образцы данных и убедиться, что приложение правильно обрабатывает информацию для отслеживания.
Примечание. Тестирование не подразумевает проверку подлинности URL-адреса обратного вызова. Для получения подробной информации см. документацию по Advanced Integrated Visibility.
Этапы проверки зависят от конкретного региона
Следующие этапы относятся только к клиентам в США и Канаде. Дополнительные сведения для резидентов других стран см. на странице Проверка API.
Для переноса API в рабочую среду их необходимо проверить. Уровень проверки зависит от конкретного API. Перед началом работы ознакомьтесь с требованиями к проверке API.
1. В меню нажмите Мои проекты, а затем выберите Название проекта.
2. На вкладке Ключи API в разделе Тестовый ключ найдите тестовые учетные данные.
3. Определите тестовые сценарии для регионов или территорий, где вы планируете развернуть свое решение. Для получения подробной информации см. Основные тестовые сценарии для интеграторов.
4. Завершите регистрационные транзакции, используя предоставленные тестовые клиентские номера, прежде чем запускать тестовые сценарии.
5. Выполните все необходимые тестовые сценарии.
6. Заполните форму информации о продукте (PIW), указав свои контактные данные и выбранные вами услуги FedEx.
7. Заполните сопроводительную записку к проверке интегратора.
Отправка итоговых материалов
Все необходимые материалы отправьте по адресу validationmtp@fedex.com.
1. Требуется подготовить следующие материалы:
- заполненная форма PIW (PDF);
- заполненная сопроводительная записка к проверке (PDF);
- транзакции по регистрации конечных клиентов с использованием многофакторной проверки подлинности (JSON);
- отсканированные транспортные этикетки для всех применимых тестовых сценариев (PDF или PNG);
- транзакции отправки с тремя форматами этикеток: PDF, PNG и ZPL (JSON) (для применимых API отправки и оценки);
- скриншоты (PDF):
- решения для обслуживания клиентов, отображающее услуги и особое обращение FedEx;
- заявления об отказе от обязательств;
- лицензионного соглашения конечного пользователя (EULA);
- процесса регистрации конечного пользователя.
2. Упакуйте все файлы в один ZIP-файл, чтобы избежать ограничений почтового поставщика.
3. Отправьте ZIP-файл команде проверки по электронной почте.
Рекомендации по предотвращению задержек
Следуйте приведенным ниже рекомендациям, чтобы сократить время проверки.
- Распечатывайте и сканируйте этикетки с разрешением не менее 600 DPI. Не отправляйте файлы, полученные непосредственно из API.
- При использовании термопринтеров необходимо запрашивать тип изображения этикетки, соответствующий модели принтера. Например: ZPLII для принтеров Zebra.
- Для FedEx International Express® необходимо указать дополнительную авианакладную.
- При отправке многоместных отправлений (Multi-Piece Shipments, MPS) необходимо прикреплять этикетку к каждой упаковке.
Оценка этикетки
Команда проверки рассмотрит вашу заявку.
- В случае отклонения учтите замечания и повторно предоставьте материалы.
- В случае одобрения вы получите письмо с подтверждением. После утверждения ваши рабочие учетные данные будут авторизованы для транзакций с транспортными этикетками.
1. В меню выберите Мои проекты, а затем — Название проекта.
2. В разделе API скопируйте и надежно сохраните рабочий ключ API и секретный ключ.
Примечание. Секретный ключ следует хранить в надежном месте, так как он отображается только один раз. При утере секретного ключа вы сможете создать новый.
