DOCS

Подключение через API

Подключить учетную запись перевозчика DHL

Безопасно подключите вашу учетную запись перевозчика DHL для доступа к согласованным тарифам доставки и создания этикеток непосредственно через Zonos.

Начало работы 

Процесс подключения учетной записи перевозчика DHL проверяет ваши учетные данные и гарантирует, что ваша учетная запись правильно настроена для получения тарифов и создания этикеток доставки. При подключении вашей учетной записи DHL Zonos выполняет тестовый вызов рейтинга для проверки правильности соединения перед сохранением ваших учетных данных.

Для регистрации в DHL Express или настройки через Zonos Dashboard выполните шаги в этом руководстве.

Как работает подключение учетной записи перевозчика DHL 

Подключение вашей учетной записи перевозчика DHL:

  • Проверяет, что вы предоставили правильные типы учетных данных для DHL
  • Выполняет живой вызов рейтинга к API DHL для подтверждения валидности учетных данных
  • Сохраняет вашу подключенную учетную запись в Zonos для будущего рейтинга отправлений и создания этикеток
  • Возвращает подробности подключенной учетной записи, включая информацию о вашей учетной записи DHL и тип тарифа

После подключения вашу учетную запись перевозчика DHL можно использовать для получения тарифов доставки в реальном времени на основе ваших согласованных тарифов (если применимо) и создания этикеток доставки DHL.

Подключение вашей учетной записи DHL 

Используйте мутацию carrierAccountConnect для подключения вашей учетной записи перевозчика DHL с вашими учетными данными.

Мутация

Используйте эту мутацию для подключения вашей учетной записи перевозчика DHL и проверки ваших учетных данных.

1mutation CarrierAccountConnect($input: CarrierAccountConnectInput!) {
2 carrierAccountConnect(input: $input) {
3 errors
4 carrierAccount {
5 credentialProvider
6 id
7 integrationType
8 organization
9 rateType
10 carrier {
11 id
12 code
13 name
14 }
15 credentials {
16 type
17 value
18 }
19 }
20 }
21}

Переменные

Мутация требует код перевозчика DHL, тип тарифа и ваши учетные данные DHL.

1{
2 "input": {
3 "carrierCode": "DHL",
4 "rateType": "NEGOTIATED",
5 "credentials": [
6 {
7 "type": "API_KEY",
8 "value": "actual_api_key_value"
9 },
10 {
11 "type": "API_PASSWORD",
12 "value": "actual_api_password_value"
13 },
14 {
15 "type": "ACCOUNT_NUMBER",
16 "value": "actual_account_number_value"
17 }
18 ]
19 }
20}

DHL требует следующих типов учетных данных:

  • API_KEY - Ваш ключ API DHL
  • API_PASSWORD - Ваш пароль API DHL
  • ACCOUNT_NUMBER - Номер вашей учетной записи DHL

Вы можете найти эти учетные данные на портале вашей учетной записи DHL или связавшись с представителем вашей учетной записи DHL.

Примеры ответов

Успешное подключение

Когда учетные данные действительны и DHL успешно возвращает тарифы:

1{
2 "data": {
3 "carrierAccountConnect": {
4 "errors": [],
5 "carrierAccount": {
6 "credentialProvider": "ORGANIZATION",
7 "id": "carrier_account_123",
8 "integrationType": "REST",
9 "organization": "organization_id",
10 "rateType": "NEGOTIATED",
11 "carrier": {
12 "id": "carrier_123",
13 "code": "dhl",
14 "name": "DHL"
15 },
16 "credentials": [
17 {
18 "type": "API_KEY",
19 "value": "actual_api_key_value"
20 },
21 {
22 "type": "API_PASSWORD",
23 "value": "actual_api_password_value"
24 },
25 {
26 "type": "ACCOUNT_NUMBER",
27 "value": "actual_account_number_value"
28 }
29 ]
30 }
31 }
32 }
33}

Ошибка: неподдерживаемый тип учетных данных

Если вы предоставляете тип учетных данных, который не поддерживает DHL:

1{
2 "data": {
3 "carrierAccountConnect": {
4 "errors": [
5 "Credential type SITE_ID is not supported by carrier DHL"
6 ],
7 "carrierAccount": null
8 }
9 }
10}

Ошибка: недействительные учетные данные

Если учетные данные имеют правильные типы, но не аутентифицируются успешно в DHL:

1{
2 "data": {
3 "carrierAccountConnect": {
4 "errors": [
5 "Failed to get rating from DHL API"
6 ],
7 "carrierAccount": null
8 }
9 }
10}

Что происходит после подключения

После успешного подключения вашей учетной записи перевозчика DHL:

  • Учетная запись сохраняется в вашей организации и связывается с вашими учетными данными
  • Вы можете получать тарифы доставки DHL, используя ваши согласованные тарифы (если применимо)
  • Вы можете создавать этикетки доставки DHL через API Zonos
  • Учетная запись перевозчика может использоваться для нескольких отправлений без повторного подключения

Дальнейшие действия 

После подключения вашей учетной записи перевозчика DHL:

GraphQL API ReferenceTypes, inputs, and operations used in this guide

Была ли эта страница полезной?