Интеграция с API
Этот раздел описывает порядок действий, которые нужно выполнить для интеграции с Диадоком через HTTP API.
Чтобы начать работу и получить доступ к API, оставьте заявку на странице Интеграция.
Адреса точек входа в API Диадока:
- https://diadoc-api.kontur.ru — главная площадка
- https://diadoc-api-staging.kontur.ru — тестовая площадка
Получение доступа к API
Чтобы начать работать с Диадоком через HTTP API, нужно зарегистрировать интеграционное решение и получить данные для авторизации — API-ключ приложения и токен доступа. Для этого:
-
Оставьте заявку на странице интеграции. После этого с вами свяжется менеджер, предоставит доступ в Кабинет интегратора и выдаст идентификатор вашего приложения
client_id. -
Выпустите в Кабинете интегратора ключ приложения
client_secret. Для этого:-
Перейдите в Кабинет интегратора.
-
В разделе «API-ключи» нажмите «+ Выпустить ключ».
-
Сохраните полученный ключ в надежное место: он понадобится для следующих действий. Это секретный ключ, не передавайте его третьим лицам.
-
-
Выберите подходящий для вашего приложения алгоритм аутентификации и получите с его помощью токен доступа
access_token.- Refresh Token Flow — подходит для роботизированных приложений, не позволяющих взаимодействовать с пользователем для авторизации. Самый простой алгоритм для автоматического обновления токена, подходит для большинства решений.
- Authorization Code Flow — подходит для бэкенд-приложений, которые могут отображать страницу авторизации.
- Device Authorization Flow — подходит для приложений с ограничениями на ввод данных для аутентификации, например, для desktop-приложений или 1С.
Выбранный способ аутентификации можно изменить в Кабинете интегратора, но изменения применятся не сразу — потребуется около 5 минут.
-
Используйте полученный токен доступа
access_tokenв заголовкеAuthorizationпри вызовах методов API Диадока:Authorization: Bearer <access_token>GET /GetMyOrganizationsHost: diadoc-api.kontur.ruAuthorization: Bearer {{access_token}}Accept: application/jsonОбратите внимание, что время жизни токена ограничено: токен нужно обновить, пока он еще активен.
Разработка интеграционного решения
После получения доступа к API:
- Ознакомьтесь с порядком передачи данных в API Диадока и выберите удобный формат данных для вашего интеграционного решения.
- Постройте свое интеграционное решение, руководствуясь инструкциями. Чтобы проверить работоспособность API в вашем интеграционном решении, вы можете воспользоваться примером со страницы Быстрый старт.
Вам может быть полезна следующая информация:
- Политика устаревания — информация о порядке устаревания методов и структур API;
- Технические особенности — информация об особенностях и ограничения API Диадока и о способах передачи данных;
- Авторизация — схема авторизации в API Диадока;
- Инструкции — инструкции по работе с API;
- Порядок документооборота — описание принципов документооборота документов в Диадоке;
- Глоссарий — информация о сущностях Диадока и интерфейсах для работы с ними;
- Документация в спецификации OpenAPI — машиночитаемое описание API для автоматизации интеграции и тестирования.
Обратите внимание, что для упрощения взаимодействия с API вы можете воспользоваться SDK с примерами.
Если у вас возникли проблемы, сообщите нам.