Об авторизации

API предоставляет два варианта авторизации:

  1. Посредством <JSON Web Token> , доступного в настройках API.

Таким образом работа с API будет от имени всего аккаунта.

  • Для получения <token> доступа перейдите в раздел Настройки > API.

  • При каждом вызове API добавьте в заголовок авторизации <token> доступа. Параметры заголовков для всех команд:

    Authorization: bearer <JSON Web Token>
    Host: api.umnico.com
    
  1. С помощью OAuth 2.

Таким образом работа с API будет от имени конкретного пользователя.

  1. Посредством <pluginToken>:

    • Первоначально необходимо зарегистрировать плагин plugin token, который возвращает <pluginToken>. Параметры заголовков будут следующими:

      Authorization: bearer <JSON Web Token>
      Host: api.umnico.com
      
    • Для получения временного <accessToken> вызывается метод авторизации по plugin token.

    • При каждом вызове API добавьте в заголовок авторизации <accessToken>. Параметры заголовков для всех команд:

      Authorization: JWT <Access Token>
      Host: api.umnico.com
      
    • Если API возвращает ошибку 401 на запрос, значит, что время жизни <accessToken> закончилось.

    • Для обновления токена нужно повторить вызов метода авторизации по plugin token.

  2. Посредством логина и пароля:

    • Первоначально вызывается метод авторизации, который возвращает два токена: <accessToken> и <refreshToken>.

    • При каждом вызове API добавьте в заголовок авторизации <accessToken>. Параметры заголовков для всех команд:

      Authorization: JWT <Access Token>
      Host: api.umnico.com
      
    • Если API возвращает ошибку 401 на запрос, значит, что время жизни <accessToken> закончилось.

    • Для обновления токена нужно вызвать специальный метод и добавить в его заголовок авторизации <refreshToken>. Параметры заголовков будут следующими:

      Authorization: JWT <Refresh Token>
      Host: api.umnico.com
      
    • Если <refreshToken> валидный, то вам вернется обновленный <accessToken>. Иначе - вернется ошибка 401 и нужно снова вызывать метод авторизации.

      Примечание

      Если время жизни <refreshToken> подходило к концу, то метод обновит и его тоже.