Перейти к основному содержимому

Интеграция с API

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

к сведению

Чтобы начать работу и получить доступ к API, оставьте заявку на странице Интеграция.

Адреса точек входа в API Диадока:

Получение доступа к API

Чтобы начать работать с Диадоком через HTTP API, нужно зарегистрировать интеграционное решение и получить данные для авторизации — API-ключ приложения и токен доступа. Для этого:

  1. Оставьте заявку на странице интеграции. После этого с вами свяжется менеджер, предоставит доступ в Кабинет интегратора и выдаст идентификатор вашего приложения client_id.

  2. Выпустите в Кабинете интегратора ключ приложения client_secret. Для этого:

    1. Перейдите в Кабинет интегратора.

    2. В разделе «API-ключи» нажмите «+ Выпустить ключ».

    3. Сохраните полученный ключ в надежное место: он понадобится для следующих действий. Это секретный ключ, не передавайте его третьим лицам.

  3. Выберите подходящий для вашего приложения алгоритм аутентификации и получите с его помощью токен доступа access_token.

    • Refresh Token Flow — подходит для роботизированных приложений, не позволяющих взаимодействовать с пользователем для авторизации. Самый простой алгоритм для автоматического обновления токена, подходит для большинства решений.
    • Authorization Code Flow — подходит для бэкенд-приложений, которые могут отображать страницу авторизации.
    • Device Authorization Flow — подходит для приложений с ограничениями на ввод данных для аутентификации, например, для desktop-приложений или 1С.

    Выбранный способ аутентификации можно изменить в Кабинете интегратора, но изменения применятся не сразу — потребуется около 5 минут.

  4. Используйте полученный токен доступа access_token в заголовке Authorization при вызовах методов API Диадока:

    Authorization: Bearer <access_token>

    Обратите внимание, что время жизни токена ограничено: токен нужно обновить, пока он еще активен.

Разработка интеграционного решения

После получения доступа к API:

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

Вам может быть полезна следующая информация:

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

Если у вас возникли проблемы, сообщите нам.

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года