DOCS

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

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

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

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

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

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

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

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

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

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

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

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

Мутация

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

МУТАЦИЯ

GraphQL

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

Переменные

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

ПЕРЕМЕННЫЕ

json

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

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

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

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

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

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

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

ОТВЕТ

json

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

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

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

ОШИБКА

json

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

Ошибка: Неверные учетные данные

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

ОШИБКА

json

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

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

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

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

Следующие шаги 

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

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