Аутентификация

Для работы с Indeed CM API вы можете использовать любые инструменты. Далее описана настройка работы с API в Swagger, Postman, Windows PowerShell и Linux Bash. Настройка инструмента зависит от типа аутентификации, заданного в Мастере настройки:

• Windows — по учетной записи Windows. Доступна только на Windows-сервере Indeed CM.
• OpenID Connect — по протоколу OAuth 2.0 с получением токена доступа. Доступна на Windows- и Linux-серверах Indeed CM.

Windows

Проверка настроек аутентификации

1. Запустите Диспетчер служб IIS (Internet Information Services (IIS) Manager).
2. В левом меню выберите сайт Default Web Site и раскройте список приложений cm.
3. Выберите приложение api.
4. В панели управления приложением выберите свойство Проверка подлинности (Authentication) и убедитесь, что выбрана Проверка подлинности Windows (Windows Authentication).
5. Закройте Диспетчер служб IIS.
6. Перейдите в каталог C:\inetpub\wwwroot\cm\api и откройте конфигурационный файл приложения Indeed CM API appsettings.json.
7. Убедитесь, что в параметре authentication установлено значение Windows.

Swagger

Чтобы работать с API через Swagger, внесите изменения в конфигурационный файл приложения Indeed CM API:

1. Перейдите в каталог C:\inetpub\wwwroot\cm\api и откройте файл appsettings.json.
2. В секции webApiSettings в параметре enableSwagger установите значение true и сохраните изменения.
3. Примените настройки на сервере Indeed CM.

Интерфейс Swagger будет доступен по ссылке https://<FQDN сервера Indeed CM>/cm/api/swagger.

При аутентификации в Swagger автоматически используются учетные данные Windows.

Postman

Чтобы настроить аутентификацию в Postman:

1. В левой части верхней панели управления Postman нажмите +. Откроется поле для ввода запросов.
2. Перейдите на вкладку Auth и в выпадающем списке выберите NTLM Authentication.
3. Введите имя пользователя в формате DOMAIN\Username и пароль.

Чтобы выполнить запрос:

1. В строке запроса выберите тип.
2. Укажите URL запроса.
3. Нажмите Send.

OpenID Connect

Проверка настроек аутентификации

Чтобы проверить настройки аутентификации в API на Windows-сервере Indeed CM:

1. Запустите Диспетчер служб IIS (Internet Information Services (IIS) Manager).
2. В левом меню выберите сайт Default Web Site и раскройте список приложений cm.
3. Выберите приложение api.
4. В панели управления приложением выберите свойство Проверка подлинности (Authentication) и убедитесь, что выбрана Анонимная проверка подлинности (Anonymous Authentication).
5. Закройте Диспетчер служб IIS.
6. Перейдите в каталог C:\inetpub\wwwroot\cm\api и откройте конфигурационный файл приложения Indeed CM API appsettings.json.
7. Убедитесь, что в параметре authentication установлено значение OAuth2Introspection.

Чтобы проверить настройки аутентификации в API на Linux-сервере Indeed CM:

1. Перейдите в каталог /opt/indeed/cm/api и откройте конфигурационный файл приложения Indeed CM API appsettings.json.
2. Убедитесь, что в параметре authentication установлено значение OAuth2Introspection.

Swagger

Чтобы работать с API через Swagger, внесите изменения в конфигурационный файл приложения Indeed CM API:

1. Перейдите в каталог C:\inetpub\wwwroot\cm\api в ОС Windows или /opt/indeed/cm/api в ОС Linux и откройте файл appsettings.json.
2. В секции webApiSettings в параметре enableSwagger установите значение true.
3. Сохраните изменения.
4. Примените настройки на сервере Indeed CM.

Чтобы аутентифицироваться в Swagger:

1. Откройте браузер и перейдите по ссылке https://<FQDN сервера Indeed CM>/cm/api/swagger.
2. В правой части окна нажмите Authorize.
3. В поле Scopes нажмите Select all.
4. Нажмите Authorize.

Postman

Чтобы настроить аутентификацию в Postman:

1. В левой части верхней панели управления Postman нажмите +. Откроется поле для ввода запросов.
2. Перейдите на вкладку Auth и в выпадающем списке выберите OAuth 2.0.
3. В поле Add auth data to оставьте значение по умолчанию Request Headers.
4. В разделе Current Token в поле Header Prefix оставьте значение по умолчанию Bearer.
5. В разделе Configure New Token заполните поля:
   • Token Name – произвольное имя токена.
   • Grant Type – Password Credentials.
   • Access Token URL – https://<FQDN сервера Indeed CM>/cm/oidc/connect/token.
   • Client ID – WebApiClient.
   • Username – имя пользователя в формате DOMAIN\Username.
   • Password – пароль пользователя.
   • Client Authentication – Send as Basic Auth header.
6. Нажмите Get New Access Token. Откроется окно с токеном.
7. Нажмите Use Token.

Чтобы выполнить запрос:

1. В строке запроса выберите тип.
2. Укажите URL запроса.
3. Нажмите Send.

Windows PowerShell

Чтобы работать с API через PowerShell, используйте PowerShell-скрипты.

Получите токен доступа и выполните запрос:

1. Определите переменные в терминале или в файле PowerShell-скрипта.

   $body = @{
       grant_type = 'password'
       username = 'DOMAIN\Username'
       password = 'P@ssw0rd'
       scope = 'openid webapi'
       client_id = 'WebApiClient'
   }
   $base_url = "https://<FQDN сервера Indeed CM>"
   $token_url = "$base_url/cm/oidc/connect/token"

2. Извлеките токен доступа (access_token) из ответа.

   $resp = Invoke-RestMethod -Method Post -Uri $token_url -Body $body
   $token = $resp.access_token

3. Добавьте полученный токен в заголовок запроса.

   $headers = @{Authorization = "Bearer $token"}

4. Выполните запрос.

   Пример GET-запроса

   Invoke-RestMethod -Method Get -Uri "$base_url/cm/api/Cards?state=Issued&offset=0&count=0" -Headers $headers
   Пример POST-запроса

   Invoke-RestMethod -Method Post -Uri "$base_url/cm/api/Cards/123/Enable" -Headers $headers

Linux Bash

Чтобы работать с API через Linux Bash, используйте Bash-скрипты.

Получите токен доступа и выполните запрос:

1. Определите переменные в терминале или в файле Bash-скрипта.

   username="DOMAIN\\username"
   password="P@ssw0rd"
   base_url="https://<FQDN сервера Indeed CM>"
   body="grant_type=password&username=$username&password=$password&scope=openid%20webapi&client_id=WebApiClient"
   token_url="$base_url/cm/oidc/connect/token"

2. Извлеките токен доступа (access_token) из ответа.

   resp=$(curl -s -X POST $token_url -H "Content-Type: application/x-www-form-urlencoded" --data $body)
   token=$(echo $resp | grep -o '"access_token": "[^"]*' | cut -d'"' -f4)

3. Добавьте полученный токен в заголовок запроса.

   headers="Authorization: Bearer $token"

4. Выполните запрос.

   Пример GET-запроса

   curl -X GET "$base_url/cm/api/Cards?state=Issued&offset=0&count=0" -H "$headers" -d ''
   Пример POST-запроса

   curl -X POST "$base_url/cm/api/Cards/123/Enable" -H "$headers" -d ''
   Пример Bash-скрипта

   #!/bin/sh
   #User input
   username="DEMO\\admin"
   password="P@ssw0rd"
   base_url="https://cm-test.local"
   body="grant_type=password&username=$username&password=$password&scope=openid%20webapi&client_id=WebApiClient"
   token_url="$base_url/cm/oidc/connect/token"
   # Get token
   resp=$(curl -s -X POST $token_url -H "Content-Type: application/x-www-form-urlencoded" --data $body)
   # Parse token
   token=$(echo $resp | grep -o '"access_token": "[^"]*' | cut -d'"' -f4)
   # Combine header
   headers="Authorization: Bearer $token"
   # Test enable card (POST)
   curl -X POST "https://cm-test.local/cm/api/Cards/123/Enable" -H "accept: */*" -d ''
   # Test Get enabled card (GET)
   curl -X GET "https://cm-test.local/cm/api/Cards?state=Issued&offset=0&count=0" -H "accept: text/plain"