O Claro Score permite identificar de forma ágil e segura os consumidores que apresentam menor risco de crédito, com o diferencial de análise de pessoas não bancarizadas. A pesquisa é realizada utilizando o CPF e retorna o valor em formato de pontuação de crédito (0 a 1000). Quanto maior for a pontuação, menor o risco de inadimplência. Para realizar a construção do score são utilizados como base o comportamento financeiro dos clientes Claro, oferecendo consistência e confiabilidade ao gerar o resultado. O acesso ocorre por meio de API , permitindo ao cliente integrar nossa solução com sua plataforma ou sistema de consulta.
A nossa API é “restful”, ou seja, o nosso protocolo de comunicação foi criado de uma forma que pode interpretar qualquer linguagem de programação. Isso torna o processo de integração do lado dos nossos clientes e parceiros mais flexível e de fácil entendimento. Na página de documentação deixamos alguns exemplos de linguagem, caso seja necessário.
Utilizado como ferramenta para obter políticas e decisões de crédito mais adequada e confiável. Dessa forma, o nosso score possibilita:
- Redução de risco de inadimplência;
- Oportunidade de novos negócios mais seguros;
- Aumento de vendas e receita sustentável;
- Fornecemos elementos diferenciais (específicos da Claro) àqueles scores já fornecidos pelos Bureaus tradicionais, incluindo o de pessoas não bancarizadas.
Versão: 1;2019-08-02
Criada por: Logicalis
Data: 02/08/2019
Modificações
- [Claro API Monetization MVP] Versão inicial
- [Claro API Monetization MVP] Atualização do swagger
Essa API usa OAuth 2 com o fluxo de concessão de credenciais do cliente.
Tipo de segurança: OAuth2
clientCredentials OAuth Flow: Token URL: https://demo35-test.apigee.net/oauth2/token?grant_type=client_credentials
Obter classificações gerais de clientes para diferentes propósitos. Essa operação retorna um número inteiro que expressa o potencial de um determinado cliente da Claro. Back-end: claro-api-managment.azure-api.net
200 - A solicitação foi bem sucedida.
400 - A solicitação não pôde ser entendida pelo servidor devido à sintaxe incorreta. O cliente NÃO DEVE repetir o pedido sem modificações.
401 - A solicitação requer autenticação do usuário.
403 - O servidor entendeu a solicitação, mas está se recusando a atendê-la.
404 - O servidor não encontrou nada que corresponda ao Request-URI.
500 - O servidor falhou ao atender uma solicitação aparentemente válida.
Caso ainda restem dúvidas, baixe o PDF que contém o tutorial de consumo da API, que explica passo a passo como utiliza-la.
!/bin/bash url_score=https://api.claro.com.br/customers/v1/scores url_token=https://api.claro.com.br/oauth2/v1/token cpf="XXXXXXXXXXX" key=XXXXXXXXXXXXXXXXXXXXXXXXXXX secret=XXXXXXXXX senha=$( echo -n $key:$secret | base64) curl -X POST $url_token -H 'Content-Type: application/x-www-form-urlencoded' -H 'cache-control: no-cache' -d 'grant_type=client_credentials' -H "x-client-auth: Basic $senha" > json grep 'access_token' json > atributoJson token=$(cut -d'"' -f4 atributoJson ) curl -X POST $url_score -H 'Content-Type: application/json' -H 'cache-control: no-cache' -H "x-client-auth: Bearer $token" -H "X-CustomerID: claro_exemplo" -d '{"data": {"customer":{"idCpf": "'$cpf'"}}}'
package client.claroScores; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import java.util.Base64; import org.codehaus.jackson.JsonProcessingException; import org.codehaus.jackson.map.ObjectMapper; import org.springframework.http.HttpEntity; import org.springframework.http.HttpHeaders; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.util.LinkedMultiValueMap; import org.springframework.util.MultiValueMap; import org.springframework.web.client.RestClientException; import org.springframework.web.client.RestTemplate; public class App { private static final String KEY = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; private static final String SECRET = "XXXXXXXXXXXX"; private static final String GRANT_TYPE = "client_credentials"; private static final String URL = "https://api.claro.com.br"; private static final String END_POINT_ACCESS_TOKEN = "/oauth2/v1/token"; private static final String END_POINT_API_SCORE = "/customers/v1/scores"; public static void main( String[] args ) throws URISyntaxException, JsonProcessingException, IOException{ App app = new App(); String token = app.getAccessToken(); String cpf = "XXXXXXXXXXX"; System.out.println("Score: " + app.getScore( token , cpf )); } public String getScore(String acessToken, String cpf) throws RestClientException, URISyntaxException { HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); headers.add("cache-control","no-cache"); headers.add("x-client-auth", "Bearer " + acessToken); headers.add("X-CustomerID", "claro_exemplo"); HttpEntityrequest = new HttpEntity<>(new Score(cpf), headers); RestTemplate restTemplate = new RestTemplate(); ResponseEntity result = restTemplate.postForEntity(new URI(URL + END_POINT_API_SCORE), request, String.class); return result.getBody(); } public String getAccessToken() throws URISyntaxException, JsonProcessingException, IOException { String senha = Base64.getEncoder().encodeToString( App.KEY.concat(":").concat(App.SECRET).getBytes() ); HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED); headers.add("cache-control","no-cache"); headers.add("x-client-auth", "Basic " + senha); MultiValueMap parameters = new LinkedMultiValueMap<>(); parameters.add("grant_type", GRANT_TYPE); HttpEntity > request = new HttpEntity<>(parameters, headers); RestTemplate restTemplate = new RestTemplate(); ResponseEntity result = restTemplate.postForEntity(new URI(URL + END_POINT_ACCESS_TOKEN), request, String.class); return new ObjectMapper().readTree(result.getBody()).get("access_token").asText() ; } class Score{ public Score(String cpf) { this.data = new Data(cpf); } private Data data; public Data getData() { return data; } public void setData(Data data) { this.data = data; } } class Data{ public Data(String cpf) { this.customer = new Customer(cpf); } private Customer customer; public Customer getCustomer() { return customer; } public void setCustomer(Customer customer) { this.customer = customer; } class Customer{ public Customer(String idCpf) { this.idCpf = idCpf; } private String idCpf; public String getIdCpf() { return idCpf; } public void setIdCpf(String idCpf) { this.idCpf = idCpf; } } } } ,>
$key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; $secret = 'XXXXXXXXXXXX'; $cpf = 'XXXXXXXXXXX'; $token = getAccessToken(); $score = getScore($token , $cpf); echo $score; function getAccessToken() { try{ $senha = base64_encode($GLOBALS['key'] . ':' . $GLOBALS['secret']); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.claro.com.br/oauth2/v1/token"); curl_setopt( $ch, CURLOPT_HTTPHEADER, [ 'Content-Type: application/x-www-form-urlencoded', 'X-CustomerID: claro_exemplo', 'x-client-auth: Basic ' . $senha ]); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLINFO_HEADER_OUT, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, 'grant_type=client_credentials'); $response = curl_exec($ch); if (!$response){ $error = curl_error($ch); $info = curl_getinfo($ch); die("cURL request failed, error = {$error}; info = " . print_r($info, true)); } if(curl_errno($ch)){ curl_close($ch); echo 'error:' . curl_error($ch); } else { curl_close($ch); return json_decode($response)->access_token; } } catch (Exception $e) { return 'Erro '. $e; } } function getScore($token , $cpf){ try { $payload = '{"data":{"customer":{"idCpf":' . $cpf . '}}}'; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.claro.com.br/customers/v1/scores"); curl_setopt( $ch, CURLOPT_HTTPHEADER, [ 'Content-Type: application/json', 'X-CustomerID: claro_exemplo', 'x-client-auth: Bearer ' . $token ]); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLINFO_HEADER_OUT, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, $payload); $response = curl_exec($ch); if (!$response){ $error = curl_error($ch); $info = curl_getinfo($ch); die("cURL request failed, error = {$error}; info = " . print_r($info, true)); } if(curl_errno($ch)){ curl_close($ch); echo 'error:' . curl_error($ch); } else { curl_close($ch); return $response; } } catch (Exception $e) { return 'Erro '. $e; } }
import requests, json import base64 KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXX" SECRET="XXXXXXXXXXX" SENHA = base64.b64encode( (KEY + ':' + SECRET ).encode('ascii') ).decode('ascii') GRANT_TYPE = "client_credentials"; URL = "https://api.claro.com.br"; END_POINT_ACCESS_TOKEN = "/oauth2/v1/token"; END_POINT_API_SCORE = "/customers/v1/scores"; headers={'Content-Type':'application/x-www-form-urlencoded','cache-control':'no-cache','x-client-auth': 'Basic {}'.format(SENHA)} data = {'grant_type': 'client_credentials'} respToken = requests.post(URL + END_POINT_ACCESS_TOKEN , headers=headers , data= data) if respToken.status_code != 200: print('Erro: ' + str( respToken.status_code)) else: token = json.loads( respToken.text)['access_token'] headers_app = {'Content-Type': 'application/json', 'X-CustomerID': 'claro_exemplo', 'cache-control':'no-cache', 'user-agent':'curl/7.60.0', 'x-client-auth': 'Bearer {}'.format(token)} cpf = "XXXXXXXXXXX" data_app = {"data":{"customer":{"idCpf": cpf }}} respScore = requests.post(URL + END_POINT_API_SCORE, headers=headers_app , data= json.dumps(data_app)) if respScore.status_code != 200: print('Erro: ' + str(respScore.status_code)) else: print('Score ' + str( respScore.text ))
Plano Trial
Para você comecar a desenvolver já!
- 1000 requisições free
- Período de 3 meses
- Relatório de consumo