EnDocs Cloud API
Эндпойнт: https://api.endocs.cloud
Приступая к работе
Вы можете начать работу с EnDocs Cloud API, подключив коллекцию к своему рабочему пространству. Затем вы можете использовать Postman для отправки запросов.
О EnDocs Cloud API
EnDocs Cloud API позволяет вам программно получать доступ к данным, хранящимся в вашей учетной записи EnDocs.
Вы должны использовать действительный токен для отправки запросов.
У API есть ограничения по скорости и использованию.
API возвращает ответы на запросы в формате JSON. Когда запрос API возвращает ошибку, она отправляется в JSON-ответе в качестве ключа ошибки.
Метод запроса (глагол) определяет характер действия, которое вы намереваетесь выполнить. Запрос, выполненный с использованием метода GET, подразумевает, что вы хотите получить информацию. Метод POST подразумевает, что вы хотите создать, отредактировать или удалить что-то.
На все запросы API отвечает соответствующими кодами состояния. В клиенте Postman код состояния также содержит текст справки, в котором подробно описывается возможное значение кода ответа.
Идентификация
Postman использует токен для аутентификации. Он сообщает серверу API, что запрос поступил от вас. Все, к чему у вас есть доступ в EnDocs, доступно с помощью вашего токена. Вы можете сгенерировать токен в разделе "1C" в настройках вашей учетной записи EnDocs, нажав на кнопку "Копировать токен".
Вы должны включать токен в каждый запрос к API. В Postman вы можете сохранить свой токен в качестве переменной окружения. Коллекция API Postman будет использовать его для выполнения вызовов API.
Если токен отсутствует, неправильно сформирован или недействителен, вы получите код ответа "401 Unauthorized response code".
Тарифы и ограничения по использованию
Ограничения скорости доступа к API применяются для каждого ключа API в единицу времени. Ограничение составляет 300 запросов в минуту. Кроме того, в зависимости от вашего тарифного плана у вас могут быть ограничения на использование. Если вы превысите любое из этих ограничений, ваш запрос вернет код состояния 429 "Слишком много запросов".
Поддержка
За помощью по доступу к EnDocs Cloud API вы можете обратиться в нашу службу технической поддержки, направив письмо на электронную почту support@endocs.ru или обратившись через чат.
EnDocs Support
Email: support@endocs.ru
Telegram: https://telegram.me/EnDocsCloud