Como se Autenticar?

Nós utilizamos JWT (JSON Web Token) como principal método de autenticação para proteger nossas APIs.

O processo de autenticação é dividido em duas etapas principais:

1. Obtenção do Token de Acesso: Você precisará fazer uma requisição POST para o endpoint https://api.viewto.me/auth.
2. Utilização do Token nas Requisições da API: Uma vez obtido o token, você o incluirá no cabeçalho Authorization de suas requisições para os demais endpoints da API, como https://api.viewto.me/docs.

1. Obtendo o Token de Acesso

Para obter o token de acesso, envie uma requisição POST para https://api.viewto.me/auth.

Esta requisição requer os seguintes campos obrigatórios no corpo (body) JSON:

• clientId: Seu ID de cliente fornecido pela viewto.me.
• clientSecret: Seu segredo de cliente fornecido pela viewto.me.

A viewto.me fornecerá os valores de clientId e clientSecret necessários para esta etapa.

2. Utilizando o Token nas Requisições da API

Após receber uma resposta bem-sucedida da chamada ao endpoint /auth, você encontrará o token de acesso (JWT) no payload da resposta.

Para fazer chamadas autenticadas para outros endpoints da API (por exemplo, https://api.viewto.me/docs), você precisará incluir os seguintes cabeçalhos (headers) em suas requisições:

• Authorization: O valor deve ser Bearer SEU_TOKEN_DE_ACESSO, onde SEU_TOKEN_DE_ACESSO é o payload JWT obtido na etapa anterior.
• x-api-key: Sua chave de API, também fornecida pela viewto.me.

O valor da x-api-key também será fornecido pela viewto.me.

Exemplo de Requisição para /auth

A seguir, um exemplo de como fazer a requisição para obter o token de acesso usando cURL:

curl --request POST \
  --url https://api.viewto.me/auth \
  --header 'Content-Type: application/json' \
  --data '{
    "clientId": "SEU_CLIENT_ID",
    "clientSecret": "SEU_CLIENT_SECRET"
  }'

Lembre-se de substituir SEU_CLIENT_ID e SEU_CLIENT_SECRET pelos seus respectivos valores.

Exemplo de Requisição Autenticada para /docs

Este é um exemplo de como utilizar o token obtido e sua API key para fazer uma requisição POST para o endpoint https://api.viewto.me/docs:

curl --request POST \
  --url https://api.viewto.me/docs \
  --header 'Authorization: Bearer SEU_TOKEN_DE_ACESSO' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: SUA_API_KEY' \
  --data '{
    "documents": [
        {
            "name": "rg",
            "options": [
                "dataValidadeRg",
                "dataEmissaoRg",
                "dataNascimento",
                "numeroRg",
                "estadoEmissaoRg",
                "filiacaoMae",
                "filiacaoPai",
                "nacionalidade",
                "nomeCompleto",
                "numeroCpf",
                "numeroRegistroRg",
                "orgaoEmissorRg"
            ]
        }
    ],
    "docsType": "rg",
    "docsURL": "https://storage.googleapis.com/publics-svg/contratoImg2.pdf",
    "docsMimeType": "application/pdf",
    "docsId": "1234"
  }'

Substitua SEU_TOKEN_DE_ACESSO pelo token JWT retornado pela chamada ao /auth e SUA_API_KEY pela sua chave de API.