Credit Risk Pro | ClearSale Docs

Introdução

O Credit Risk Pro é o produto de modelos customizados para análise de crédito. Esse produto oferece scores a partir da construção de modelos complexos e customizados utilizando a tecnologia de Machine Learning.

Autenticação

Todas as requisições submetidas à nossa API devem ser realizadas através de um token de 2048 caracteres.

O token é gerado através de um usuário e senha que devem ser fornecidos pela ClearSale.

Entre em contato com o seu consultor de vendas para maiores informações.

Na autenticação, além do token retornamos seu tempo de expiração. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nesse tempo de expiração.

Para o recebimento desse dado é necessário que reserve um espaço de 2048 caracteres. Só gere um novo token após a expiração do seu token atual.

Requisição

POST https://productsapi.clearsale.com.br/v1/authentication/ HTTP/1.1
Content-Type: application/json
{
    "Username": "{Seu Usuário}",
    "Password": "{Sua Senha}"
}

POST https://hmlproductsapi.clearsale.com.br/v1/authentication/ HTTP/1.1
Content-Type: application/json
{
    "Username": "{Seu Usuário}",
    "Password": "{Sua Senha}"
}

Resposta

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "Token": "{Valor do Token}",
    "ExpiresInSeconds": "{Tempo de Expiração do Token}"
}

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "errors": {
        "ExampleProperty": [
            "error description."
        ],
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "error title.",
    "status": 400,
    "traceId": "automatically generate id"
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8
{
    "message": "Username or Password is incorrect"
}

Transação

Envio

Este método é utilizado para fazer o envio de uma transação para a API do Credit Risk Pro.

Requisição

POST https://productsapi.clearsale.com.br/v1/creditriskpro/transaction HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "document":"12345678901",(obrigatório)
    "criterion": 1 (obrigatório)

}

POST https://hmlproductsapi.clearsale.com.br/v1/creditriskpro/transaction HTTP/1.1
Content-Type: application/json
Accept:application/json
Authorization: Bearer {Token}
{
    "document":"12345678901",(obrigatório)
    "criterion": 1 (obrigatório)

}

Resposta

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
    "id": "5f67fb47f8e74ff6a9f3dab49c04389a",
    "document": "12345678901",
    "criterion": 1,
    "creationDateUtc": "2022-01-18T14:30:37.5152808Z",
    "scores": [
        {
            "name": "Score Geral",
            "value": "500"
        }
    ]
}

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "detail": "Please refer to the errors property for additional details",
    "instance": "/Transaction/",
    "errors": {
        "Document": [
            "'Document' must not be empty.",
            "Document CPF is invalid!",
            "The lenght of 'Document' must be at least 11 characters."
        ],
        "Criterion": [
            "'Criterion' must not be empty."
        ]
    }
}

HTTP/1.1 204 No Content

HTTP/1.1 500 Internal Server Error
{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
    "title": "Internal server error.",
    "status": 500,
    "detail": "The server encountered an unexpected condition that prevented it from fulfilling the request.",
    "instance": "/Transaction/"
}

HTTP/1.1 401 Unauthorized

HTTP/1.1 403 Forbidden

Dicionário de variáveis

Transaction

Nome	Descrição	Tipo	Tamanho	Obrigatório
Document	CPF para consulta	String	11	Sim
Criterion	Id do modelo customizado	Int	-	Sim

Results

Nome	Descrição	Tipo	Tamanho
Id	Código da transação	String	32
Document	CPF consultado	String	11
Criterion	Id do modelo customizado de consulta	Int	-
CreationDateUtc	Data de criação da transação no padrão UTC	DateTime	-
Scores	Lista com os scores retornados	Array	-

Scores

Nome	Descrição	Tipo	Tamanho
Name	Nome do score retornado	String	-
Value	Valor do score retornado	String	-

Homologação

Para realizar testes e validações dos possíveis retornos, esteja atento às considerações listadas abaixo:

Considerações:

O campo Document é obrigatório e deverá ter um CPF válido.
Para o ambiente de Homologação, o valor do campo Criterion deverá ser 1.
Para o ambiente de Homologação, o score gerado será um valor aleatório.