POST api/v2/auth

Авторизация по логину и паролю

Информация о запросе

GET параметры

None.

Body параметры

Параметры авторизации

AuthModel
НазваниеОписаниеТипДополнительная информация
Login

Логин

string

Нет.

Password

Пароль

string

Нет.

AppInfo

Информация о клиентском приложении

AppInfoClass

Нет.

Форматы запроса

application/json, text/json

Пример:
{
  "Login": "sample string 1",
  "Password": "sample string 2",
  "AppInfo": {
    "AppId": "06ec897e-0e4f-4179-9020-6579aec340a2",
    "AppInstance": "2adcdde1-ba41-4ea8-a8e6-78076b9f4f36"
  }
}

application/xml, text/xml

Пример:
<AuthModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Taxnet.Transcrypt.Api20.Models">
  <AppInfo>
    <AppId>06ec897e-0e4f-4179-9020-6579aec340a2</AppId>
    <AppInstance>2adcdde1-ba41-4ea8-a8e6-78076b9f4f36</AppInstance>
  </AppInfo>
  <Login>sample string 1</Login>
  <Password>sample string 2</Password>
</AuthModel>

application/x-www-form-urlencoded

Пример:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AuthModel'.

Информация об ответе

Информация о ресурсах

Токен авторизации

AuthSucceedModel
НазваниеОписаниеТипДополнительная информация
Token

Токен авторизации

globally unique identifier

Нет.

Organizations

Организации пользователя

Массив Organization

Нет.

NeedSignLicense

Нужно подписать лицензионное соглашение

boolean

Нет.

IsNewClient

У организации статус новый

boolean

Нет.

IsNewEmployee

У сотрудника статус новый

boolean

Нет.

IsNewCertificate

У сертификата статус новый

boolean

Нет.

CertificateNotFound

Сертификат не зарегистрирован в системе

boolean

Нет.

Error

Текст ошибки авторизации

string

Нет.

Форматы ответа

application/json, text/json

Пример:
{
  "Token": "7020b22a-e009-4379-bafd-169735ab10f9",
  "Organizations": [
    {
      "Id": "c743dc4b-809c-4ffa-a797-afe1221a5741",
      "Name": "sample string 2",
      "DocflowMemberId": "sample string 3",
      "OrganizationJur": {
        "Inn": "sample string 1",
        "Kpp": "sample string 2"
      },
      "OrganizationNat": {
        "Inn": "sample string 1"
      }
    },
    {
      "Id": "c743dc4b-809c-4ffa-a797-afe1221a5741",
      "Name": "sample string 2",
      "DocflowMemberId": "sample string 3",
      "OrganizationJur": {
        "Inn": "sample string 1",
        "Kpp": "sample string 2"
      },
      "OrganizationNat": {
        "Inn": "sample string 1"
      }
    }
  ],
  "NeedSignLicense": true,
  "IsNewClient": true,
  "IsNewEmployee": true,
  "IsNewCertificate": true,
  "CertificateNotFound": true,
  "Error": "sample string 7"
}

application/xml, text/xml

Пример:
<AuthSucceedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Taxnet.Transcrypt.Api20.Models">
  <CertificateNotFound>true</CertificateNotFound>
  <Error>sample string 7</Error>
  <IsNewCertificate>true</IsNewCertificate>
  <IsNewClient>true</IsNewClient>
  <IsNewEmployee>true</IsNewEmployee>
  <NeedSignLicense>true</NeedSignLicense>
  <Organizations>
    <AuthSucceedModel.Organization>
      <DocflowMemberId>sample string 3</DocflowMemberId>
      <Id>c743dc4b-809c-4ffa-a797-afe1221a5741</Id>
      <Name>sample string 2</Name>
      <OrganizationJur>
        <Inn>sample string 1</Inn>
        <Kpp>sample string 2</Kpp>
      </OrganizationJur>
      <OrganizationNat>
        <Inn>sample string 1</Inn>
      </OrganizationNat>
    </AuthSucceedModel.Organization>
    <AuthSucceedModel.Organization>
      <DocflowMemberId>sample string 3</DocflowMemberId>
      <Id>c743dc4b-809c-4ffa-a797-afe1221a5741</Id>
      <Name>sample string 2</Name>
      <OrganizationJur>
        <Inn>sample string 1</Inn>
        <Kpp>sample string 2</Kpp>
      </OrganizationJur>
      <OrganizationNat>
        <Inn>sample string 1</Inn>
      </OrganizationNat>
    </AuthSucceedModel.Organization>
  </Organizations>
  <Token>7020b22a-e009-4379-bafd-169735ab10f9</Token>
</AuthSucceedModel>