Документерра: руководство пользователя

Устранение неполадок API

В этом разделе рассматриваются типичные проблемы, с которыми можно столкнуться при работе с API Документерры, а также предлагаются основные шаги для их определения, диагностики и устранения.

Ошибка 401: Данные для аутентификации не переданы

В системе Документерра используется базовая авторизация, поэтому обязательно используйте соответствующий параметр при настройке среды в выбранном вами инструменте API. 

Вот так выглядит вкладка Authorization (Авторизация) в Postman :

Вкладка "Авторизация" в Postman — Базовая авторизация

Another thing to pay attention to is the credentials. Обязательно используйте свой логин в системе Документерра в качестве логина, а ключ APIв качестве пароля (не пароль от портала в Документерре).

Ошибка 500: Внутренняя проблема сервера

Эта ошибка обычно возникает, когда что-то не так с синтаксисом вызова API. Если вы получили код ошибки 500:

  • Проверьте регистр. Все значения, включая логические, чувствительны к регистру, поэтому убедитесь, что вы пишете true, а не True, и т.д.
  • Если вы используете один из скриптов, например,Массовое создание авторизованных читателей, убедитесь, что вы заменили все значения плейсхолдеров, такие как адрес вашего портала, пути к файлам, имя файла сертификата сервера и т.д..
  • Убедитесь, что JSON-файл имеет сформирован правильно. Это означает, что если вы передаете несколько объектов за один вызов, они должны быть помещены в такой массив:
    Пример правильно сформированного JSON-файла 

    JSON
    [
    {
    "userName": "John",
    "userInfo": {
    "email": "johndoe@company.co",
    "firstName": "John",
    "middleName": "M",
    "lastName": "Doe"
    },
    "userRole": "Role1",
    "isDontSendEmail": false
    },
    {
    "userName": "Alex",
    "userInfo": {
    "email": "alexsmith@company.co",
    "firstName": "Alex",
    "middleName": "F",
    "lastName": "Smith"
    },
    "userRole": "Role1",
    "isDontSendEmail": false
    },
    ]

Прочее

Ниже приведены некоторые другие стандартные причины, по которым вызов API может работать не так, как ожидалось:

  • Использование неверного HTTP в вызове API, например, если вы укажетеGETвместоPOST при создании пользователя.
  • Специальные символы могут быть искажены при использовании cURL.
  • Ваша версия TLS ниже 1.2.
Если вы перепробовали все вышеперечисленное, но ничего не помогает, или ошибка, с которой вы столкнулись, не упоминается на данной странице, не стесняйтесь обращаться к нашей Службе поддержки. Не забудьте предоставить им запрос и тело ответа на вызов API или снимок экрана с ошибкой.