Отправитель FedEx
Требования
Чтобы начать работу с FedEx Developer Portal и создать организацию, необходим идентификатор пользователя FedEx.
Присоединитесь к организации вашей компании, чтобы начать совместную работу с коллегами. Если у вашей компании нет организации, ее можно создать.
Присоединение к существующей организации
1. Запросите приглашение.
Попросите администратора вашей организации отправить вам приглашение. У вас будет 24 часа, чтобы принять его. Если срок действия приглашения истек, попросите администратора отправить его повторно.
2. Примите приглашение.
Войдите в систему, используя существующий идентификатор пользователя и пароль. Если ваш идентификатор уже связан с другой организацией, вам необходимо создать новый.
Создание новой организации
Создав организацию, вы станете ее администратором и сможет приглашать пользователей присоединиться, назначать им роли и проекты, а также управлять учетными записями отправителей.
Подробные сведения о ролях пользователей см. в Руководстве по администрированию организации.
1. Войдите на портал FedEx Developer Portal.
2. В меню выберите Мои проекты, а затем нажмите Создать организацию.
3. Введите указанные ниже данные.
- В поле Я работаю в компании, которая... укажите Занимается отправкой грузов через FedEx, и ей нужно интегрировать API FedEx в свои приложения.
- Введите название компании, ее веб-сайт и название организации, которое будет понятно вашей команде, например название отдела, подразделения или региона.
4. Выберите Создать.
Изменить или добавить сведения можно позже в разделе Управление организацией.
Добавление учетной записи отправителя
1. Выберите Добавить учетные записи отправителей на плитке Добавить учетные записи. Если у вас нет учетной записи FedEx, нажмите Создать учетную запись или обратитесь в службу поддержки клиентов FedEx.
2. Выберите + Добавить учетную запись.
3. Укажите свою учетную запись, псевдоним учетной записи и адрес для выставления счетов, который вы использовали при создании учетной записи.
4. Примите Лицензионное соглашение конечного пользователя или передайте его уполномоченному представителю вашей компании.
Добавление учетной записи плательщика
1. Откройте вкладку Учетные записи плательщиков. Если у вас нет учетной записи плательщика FedEx, нажмите Создать учетную запись плательщика или обратитесь в службу поддержки клиентов FedEx.
2. Выберите Добавить учетную запись плательщика. Адрес плательщика должен находиться в США.
3. Укажите свою учетную запись, псевдоним учетной записи и адрес для выставления счетов в США, который вы использовали при создании учетной записи.
4. Прочтите и примите Лицензионное соглашение конечного пользователя.
Приглашение пользователей от имени администратора
1. В меню выберите Управление организацией и перейдите на вкладку Пользователи.
2. Выберите + Добавить пользователей.
3. Выберите страну или регион и предпочитаемый язык, затем выберите роль: наблюдатель, участник или администратор.
4. При необходимости назначьте пользователю проект. Вы можете назначить пользователей в любой момент на странице Обзор проекта.
5. Укажите адреса электронной почты пользователей и нажмите Пригласить. Можно пригласить до 20 пользователей одновременно, при этом их адреса электронной почты нужно разделить запятыми. Приглашения действительны в течение 24 часов.
Создание проекта API
1. В меню выберите Мои проекты, а затем нажмите API и выберите + Создать проект API.
2. Подтвердите задачи API.
3. Выберите API, которые необходимо включить в проект.
4. Укажите название проекта и выберите страны, в которые вы планируете отправить посылку, чтобы получить тестовую учетную запись отправителя. Чтобы протестировать внутренние отправления в странах Европы, необходима отдельная учетная запись для каждой страны. Вы сможете добавить или удалить страны позже.
5. В разделе Уведомления выберите Настройки, чтобы задать параметры уведомлений.
6. Прочтите и примите условия и положения.
Создать проект 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.
Перенос проекта в рабочую среду
Настройте рабочую конфигурацию перед запуском. Вы можете переименовать ключ, добавить дополнительные учетные записи после запуска проекта и проверить клиентский номер, выбранный при создании. Он будет использоваться при переносе проекта в рабочую среду.
Примечание. Проекты Advanced Integrated Visibility на основе клиентских номеров не требуют активации в рабочей среде.
1. В меню нажмите Мои проекты, а затем выберите Название проекта.
2. Откройте вкладку Рабочий ключ.
3. Сохраните учетные данные рабочей среды и обеспечьте их безопасность.
- Скопируйте рабочий ключ API и секретный ключ и обеспечьте их безопасность.
- Запрашивая рабочий ключ, сохраните его в надежном месте, так как он отображается только один раз. При утере секретного ключа вы сможете создать новый.
4. Нажмите Далее, чтобы просмотреть сведения о проекте на вкладке Рабочий ключ.
Чтобы добавить учетные записи отправителей, нажмите кнопку Изменить в верхней части таблицы учетных записей отправителей.
Этапы проверки зависят от конкретного региона
Следующие этапы относятся только к клиентам в США и Канаде. Дополнительные сведения для резидентов других стран см. на странице Проверка API.
Проверка API
Некоторые API FedEx требуют проверки транспортных этикеток перед использованием в рабочей среде. Перед началом работы ознакомьтесь с требованиями к проверке API.
1. В меню нажмите Мои проекты, а затем выберите Название проекта.
2. На вкладке Ключи API в разделе Тестовый ключ найдите тестовые учетные данные.
3. После тестирования перенесите проект в рабочую среду на портале FedEx Developer Portal, чтобы начать проверку.
- Запрашивая рабочий ключ, сохраните его в надежном месте, так как он отображается только один раз. При утере секретного ключа вы сможете создать новый.
4. Укажите необходимую информацию на титульном листе этикетки, включая контактные данные, услуги, которые вы планируете включить, клиентский номер и рабочий ключ API.
5. Создайте образцы этикеток в тестовой среде FedEx и отправьте их на проверку в группу анализа штрих-кодов FedEx. Для проверки этикетки потребуется около трех рабочих дней.
Рекомендации по предотвращению задержек
- Распечатывайте и сканируйте этикетки с разрешением не менее 600 DPI. Не отправляйте файлы, полученные непосредственно из API.
- При использовании термопринтеров необходимо запрашивать тип изображения этикетки, соответствующий модели принтера. Например: ZPLII для принтеров Zebra.
- Для образцов этикеток используйте действительные адреса отправителя и получателя. Создавайте этикетки только для тех услуг, которые вы планируете использовать.
- Для услуги FedEx «Оплата при доставке» (C.O.D.) включите этикетку для возврата C.O.D.
- Для FedEx International Express® необходимо указать дополнительную авианакладную.
- Многоместные отправления (MPS) должны включать отдельную этикетку для каждого грузового места.
Отправьте материалы одним из следующих способов:
- отправьте файл в формате PDF и титульный лист этикетки по электронной посте: label@fedex.com;
- отправьте физические этикетки по адресу:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Примечание. При использовании физических этикеток убедитесь в отсутствии видимых дефектов, таких как чернильные полосы или повреждения. Не меняйте масштаб этикеток при печати.
6. Группа анализа штрих-кодов FedEx проведет оценку полученных тестовых этикеток и утвердит или отклонит их. Если этикетки не прошли проверку, внесите требуемые изменения и повторно отправьте их на утверждение.
7. После утверждения группа анализа штрих-кодов FedEx отправит вам уведомление по электронной почте и сообщит об авторизации рабочих учетных данных для использования транспортных этикеток.
Примечание. Утверждение производится отдельно для каждого проекта. Для новых проектов также требуется утверждение.
8. Замените тестовый URL-адрес и тестовые учетные данные рабочими.
9. Проведите заключительную проверку с тестовыми данными, чтобы убедиться, что все работает должным образом.
