Postman
A Postman collection per language, generated from the API's contract, with an optional environment for your key and the Collection Runner's data.
Download
The Postman button, at the top of every page, downloads the collection in English. Every file:
| File | English | Português |
|---|---|---|
| Collection | DocsOCR.en.postman_collection.json | DocsOCR.pt-BR.postman_collection.json |
| Environment | DocsOCR.en.postman_environment.json | DocsOCR.pt-BR.postman_environment.json |
| Collection Runner data | DocsOCR.runner-data.json |
Import
- In Postman, use Import with the collection. You can also paste the file's address.
- In the collection's Variables tab, paste your API key into
apiKey. Do not share that value. - Run Start here → 1. Check the prices, which needs no key, and 2. Extract the sample certificate.
The environment is optional. To keep the key out of the collection, import it too, pick DocsOCR (en) and paste the key into its apiKey: it is a secret, and it takes the place of the collection's variable.
What the collection holds
- Start here: the prices and the sample certificate.
- Extraction: from a URL, from a file in base64 (in the
imageBase64variable), withresizeImage, and with the fast engine. - Marriage certificate: the sample marriage certificate, on its own endpoint, and a birth certificate sent to that endpoint, refused at no cost.
- Refusals at no cost: no key, an unknown engine, an image below our standard, and a link that does not open.
- Reference: the document types and the API's status.
Each request has short tests: the expected status and, on a refusal, the errorCode. Each extraction sends a new requestId, and the refusals' messages come in the language of the language variable.
Collection Runner
The data file has one imageUrl per row. In the Collection Runner, pick the From an image URL request, load the file and run: each row is an extraction, and each one costs credits when it returns data.