Postman
Uma coleção do Postman por idioma, gerada do contrato da API, com um ambiente opcional para a sua chave e os dados do Collection Runner.
Baixe
O botão Postman, no topo de cada página, baixa a coleção em português. Todos os arquivos:
| Arquivo | Português | English |
|---|---|---|
| Coleção | DocsOCR.pt-BR.postman_collection.json | DocsOCR.en.postman_collection.json |
| Ambiente | DocsOCR.pt-BR.postman_environment.json | DocsOCR.en.postman_environment.json |
| Dados do Collection Runner | DocsOCR.runner-data.json |
Importe
- No Postman, use Import com a coleção. Também dá para colar o endereço do arquivo.
- Na aba Variables da coleção, cole a sua chave de API em
apiKey. Não compartilhe esse valor. - Rode Comece aqui → 1. Ver os preços, que não precisa de chave, e 2. Extrair a certidão de exemplo.
O ambiente é opcional. Para guardar a chave fora da coleção, importe-o também, selecione DocsOCR (pt-BR) e cole a chave na apiKey dele: ela é do tipo secret e vale no lugar da variável da coleção.
O que tem na coleção
- Comece aqui: os preços e a certidão de exemplo.
- Extração: a partir de uma URL, de um arquivo em base64 (na variável
imageBase64), comresizeImagee com o motor fast. - Certidão de casamento: a certidão de casamento de exemplo, no endpoint dela, e uma certidão de nascimento enviada a esse endpoint, recusada sem custo.
- Recusas sem custo: sem chave, um motor desconhecido, uma imagem abaixo do padrão e um link que não abre.
- Referência: os tipos de documento e o status da API.
Cada requisição tem testes curtos: o status esperado e, numa recusa, o errorCode. Cada extração envia um requestId novo, e as mensagens das recusas vêm no idioma da variável language.
Collection Runner
O arquivo de dados traz uma imageUrl por linha. No Collection Runner, escolha a requisição A partir de uma URL, carregue o arquivo e rode: cada linha é uma extração, e cada uma custa créditos quando retorna dados.