Como emitir um token de serviço

Aqui está um guia passo a passo sobre como emitir um token de serviço no Oz API 5 e 6.

1

Etapa 1

Autorize usando sua conta ADMIN: {{host}}/api/authorize/auth.

Exemplo de solicitação

curl -L 'https://{{host}}/api/authorize/auth' \
-H 'Content-Type: application/json' \
--data-raw '{
    "credentials": {
        "email": "[e-mail]",
        "password": "your_admin_password"
    }
}'

Exemplo de resposta

{
  …
    "user": {
        "user_type": "ADMIN",
  …
    },
    "access_token": "<token>",
    …
}

2

Etapa 2 (opcional)

Esta etapa pode ser omitida se já existir uma empresa.

Como um usuário deve pertencer a uma empresa, crie uma empresa: chame {{host}}/api/companies/ com o nome da sua empresa.

Exemplo de solicitação

curl -L 'https://{{host}}/api/companies/'
-H 'X-Forensic-Access-Token: token_id'
-H 'Content-Type: application/json'
-d '{ "name": "your_company_name" }'

Exemplo de resposta

{
    "company_id": "company_id",
    "name": "your_company_name",
    "in_deletion": false,
    "technical_meta_data": {}
}

3

Etapa 3

Crie um usuário de serviço. Chame {{host}}/api/users/ e anote user_id que você receberá na resposta.

Exemplo de solicitação

 curl -L 'https://{{host}}/api/users/'
-H 'X-Forensic-Access-Token: token_id'
-H 'Content-Type: application/json'
--data-raw '{
  "credentials": {
    "email": "<[e-mail]>",
    "password": "<your_service_user_password>"
  },
  "profile": {
    "company_id": " company_id",
    <!-- the next line is for API 6 -->
    "user_type": "CLIENT_SERVICE",
    "first_name": "first_name",
    "last_name": "last_name",
    "middle_name": "",
    "is_admin": false,
    <!-- the next line is for API 5 and below -->
    "is_service": true,
    "can_start_analyse_biometry": true,
    "can_start_analyse_collection": true,
    "can_start_analyse_documents": true,
    "can_start_analyse_quality": true
  }
}

Exemplo de resposta

{
    "user_id": "user_id",
    "user_type": "CLIENT_SERVICE",
     …
    "is_active": true,
     …
    "is_service": true
}

Assim como na API 6,0, a lógica de emissão de um token de serviço mudou um pouco, aqui estão exemplos para os casos de API 6 e API 5 (e anteriores).

API 6

No corpo da requisição, defina user_type como CLIENT_SERVICE.

{
  "credentials": {
    "email": " <[e-mail]> ",
    "password": "your_client_service_user_password"
  },
  "profile": {
    "company_id": "{{company_id}}",
    "user_type": "CLIENT_SERVICE",
    "first_name": "john",
    "last_name": "doe",
    "middle_name": "",
    "can_start_analysis_biometry": true,
    "can_start_analysis_collection": true,
    "can_start_analysis_documents": true,
    "can_start_analysis_quality": true
  }
}

API 5 e anteriores

Defina o is_service valor da flag como true.

{
    "credentials": {
        "email": "[e-mail]",
        "password": "your_client_service_user_password"
    },
    "profile": {
        "company_id": "{{company_id}}",
        "user_type": "CLIENT",
        "first_name": "john",
        "last_name": "doe",
        "middle_name": "",
        "is_admin": false,
        "is_service": true,
        "can_start_analyse_biometry": true,
        "can_start_analyse_collection": true,
        "can_start_analyse_documents": true,
        "can_start_analyse_quality": true
    }
}

4

Etapa 4

Se for necessário obter o token de serviço para usá-lo, por exemplo, com Web SDK, autorize como ADMIN (assim como na Etapa 1) e chame:

• API 6: {{host}}/api/authorize/service_token/{user_id} com user_id da etapa anterior.

• API 5 e anteriores: {{host}}/api/authorize/service_token.

Exemplo de solicitação

curl -L 'https://{{host}}/api/authorize/service_token/{{user_id}}' \
-H 'X-Forensic-Access-Token: token_id' \
-H 'Content-Type: application/json'

Exemplo de resposta

{
    "token_id": "token_id",
    "user_id": "user_id",
    "access_token": "service_token",
    "expire_date": 1904659888.282587,
    "session_id": 0
}

Na resposta, você obterá um token de serviço que poderá usar em quaisquer processos de serviço.

Para Web SDK, especifique o valor deste token como api_token em arquivo de configuração do Web Adapter.