Guia de Início Rápido

Siga estes passos para fazer sua primeira chamada à API:

1. Obtenha suas credenciais de API (clientId, clientSecret, x-api-key) e um token de acesso conforme descrito na seção Autenticação.
2. Escolha uma imagem ou documento PDF que você deseja analisar.
3. Envie este documento para uma URL publicamente acessível.
4. Construa um corpo de requisição JSON:
   • Defina docsURL para a URL do seu documento.
   • Defina docsMimeType para o tipo MIME correto (por exemplo, image/jpeg ou application/pdf).
   • Decida se você conhece o tipo do documento.
     • Si sim, defina docsType (por exemplo, "cnh") e no array documents, adicione um objeto com name correspondendo a docsType e as options desejadas.
     • Se não, omita docsType. No array documents, adicione objetos para cada tipo de documento potencial (por exemplo, um para "cnh", um para "rg") com suas respectivas options desejadas.
   • Opcionalmente, adicione um docsId para sua referência.
5. Envie uma requisição POST para o endpoint desejado (ex: https://api.viewto.me/docs) com seu corpo JSON e os cabeçalhos de autenticação (Authorization: Bearer SEU_TOKEN e x-api-key: SUA_API_KEY) e o cabeçalho Content-Type: application/json.
6. Inspecione a resposta para dados extraídos.

Exemplo (Requisição POST Genérica para /docs):

# Primeiro, obtenha o token (veja a seção Autenticação)
# Assumindo que você tem SEU_TOKEN_DE_ACESSO e SUA_API_KEY

curl --request POST \
  --url https://api.viewto.me/docs \
  --header 'Authorization: Bearer SEU_TOKEN_DE_ACESSO' \
  --header 'x-api-key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "docsMimeType": "image/jpeg",
    "docsId": "quickstart-test",
    "documents": [
      {
        "name": "cnh",
        "options": ["nomeCompleto", "numeroCpf", "dataNascimento"]
      }
    ],
    "docsURL": "SUA_URL_DE_DOCUMENTO_PUBLICA_AQUI"
  }'

Substitua SUA_URL_DE_DOCUMENTO_PUBLICA_AQUI, SEU_TOKEN_DE_ACESSO e SUA_API_KEY pelos valores reais.