Imagens

Em várias situações é necessário enviar imagens para a nossa API, a fim de realizar operações de OCR, FaceMatch e validação de documentos. Para tanto, é preciso inicialmente realizar o upload da imagem para depois enviá-la para análise.

Ao enviar uma imagem utilizando o endpoint /image uma GUID (Globally Unique Identifier) é retornada. Este valor deverá ser utilizado nas chamadas subsequentes para referenciar esta imagem.

Envio

Exemplo de envio utilizando o cUrl

    curl    -F "data=@path/to/local/file" \
            -H "Authorization: EXAMPLE-OF-API-KEY" \
            "https://api.caas.qitech.app/image?type=face"

Response Body

    {
        "image_id": "f4b5337a-7b50-406e-8c8e-7d0e77b5aa02",
        "image_size": "134232",
        "image_dimensions": "630x230"
    }

Para enviar uma imagem, basta realizar o envio da imagem no formato .jpeg em multipart/form-data com uma requisição POST no endpoint:

https://api.caas.qitech.app/api/image?type=$type

Onde $type é a classificação da imagem e deve ser enviado conforme um dos seguintes enumeradores (Caso a imagem sendo enviada não se enquadre em nenhuma das classificações, entrar em contato com o suporte para que providenciem a adição):

face
driver_license
id
contract

Após o envio, será retornado um objeto JSON com a GUID que aponta para a imagem que foi enviada.

Recuperação dos Arquivos

Leitura de imagem

    curl "https://api.caas.qitech.app/api/image/f4b5337a-7b50-406e-8c8e-7d0e77b5aa02/file" \
         -H "Authorization: EXAMPLE-OF-API-KEY"

Após o envio de uma imagem para a API, é possível recuperá-la por meio de uma requisição GET adequadamente autenticada no endpoint:

https://api.caas.qitech.app/api/image/{image_key}/file

Onde image_key é o valor retornado durante o envio da imagem.

Recuperação dos meta-dados do arquivo

Leitura de meta dados

    curl "https://api.caas.qitech.app/api/image/f4b5337a-7b50-406e-8c8e-7d0e77b5aa02" \
         -H "Authorization: EXAMPLE-OF-API-KEY"

Após o envio de uma imagem para a API, é possível recuperar os meta-dados da imagem utilizando o endpoint:

https://api.caas.qitech.app/api/image/{image_key}