Recuperação da imagem aprovada na Captura de Documentos

É possível recuperar as imagens nos nossos servidores através do campo sessionId, informado na response dos nossos SDKs. Para isso, é preciso autenticar na nossa API, recuperar o token de autenticação e utilizá-lo para fazer uma chamada e recuperar as imagens. Abaixo um passo a passo de como realizar esse processo.

Exemplo

Primeiramente, faça a chamada de autenticação, passando os seguintes parâmetros:

clientId - identifica o cliente junto à ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs.
clientSecret - chave de autenticação da ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs.

Requisição no ambiente de produção

POST https://documentoscopysdk.clearsale.com.br/api/v2/authentication
Content-Type: application/json
{
    "clientId": "*******",
    "clientSecret": "*******"
}

Requisição no ambiente de homologação

POST https://documentoscopysdk-hml.clearsale.com.br/api/v2/authentication
Content-Type: application/json
{
    "clientId": "*******",
    "clientSecret": "*******"
}

Resposta de sucesso

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "accessToken":"*******",
    "expiresIn": 300,
    "tokenType": "Bearer",
}

Resposta de erro 401

HTTP/1.1 401 OK
Content-Type: application/json; charset=utf-8
{
    "title": "An error occurred with client credentials.",
    "status": 401,
    "instance": "/api/v2/authentication"
}

Resposta de erro 500

HTTP/1.1 500 InternalServerError
Content-Type: application/json; charset=utf-8
{
    "title": "Unespected server error. Please try again later",
    "status": 500,
    "instance": "/api/v2/authentication"
}

Em caso de sucesso, você receberá o accessToken que é necessário para fazer a chamada para recuperação da imagem. Para isso, você deve fazer a seguinte chamada, substituindo o parâmetro SESSIONID, pelo valor do sessionId que foi retornado pelo SDK. Para saber como recuperar o SessionID:

no SDK iOS [clique aqui].
no SDK Android [clique aqui].
no SDK Web [clique aqui].

Requisição no ambiente de produção

GET https://documentoscopysdk.clearsale.com.br/api/v2/document/SESSIONID HTTP/1.1
Content-Type: application/json
Authentication: Bearer accessToken

Requisição no ambiente de homologação

GET https://documentoscopysdk-hml.clearsale.com.br/api/v2/document/SESSIONID HTTP/1.1
Content-Type: application/json
Authentication: Bearer accessToken

Resposta de sucesso

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{ 
    "identifierId": "<ID único de rastreamento da transação>",
    "sessionId": "<SESSIONID>",
    "documentType": "<rg|cnh>",
    "images": [
                {
                    "side":"<front|back>",
                    "base64":"<base64>"    
                },
                                {
                    "side":"<front|back>",
                    "base64":"<base64>"
                },
    ],
}

Resposta de erro 401

HTTP/1.1 401 OK
Content-Type: application/json; charset=utf-8
{
    "title": "AccessToken is improperly formatted.",
    "status": 401,
    "instance": "/api/v2/document/SESSIONID"
}

Resposta de erro 500

HTTP/1.1 500 InternalServerError
Content-Type: application/json; charset=utf-8
{
    "title": "Unespected server error. Please try again later",
    "status": 500,
    "instance": "/api/v2/document"
}