API Partner

A API Partner do Concilia+ permite que software houses busquem as vendas e os recebimentos de cartão dos clientes que usam o Concilia+, com autorização de cada cliente.

É uma API servidor a servidor, somente leitura, em JSON sobre HTTPS. Ela não aceita chamadas de navegador (não há CORS).

Como funciona

1. O Concilia+ cadastra a sua software house e entrega o client_id e o client_secret. Veja Cadastros necessários.
2. Você troca essas credenciais por um token de acesso de 10 minutos em POST /oauth/token.
3. Você pede acesso aos dados de um cliente pelo CNPJ em POST /v1/access-requests.
4. O cliente vê o pedido no painel do Concilia+ e aprova (ou recusa).
5. Você consulta o pedido em GET /v1/access-requests/{cnpj}. Aprovado, recebe o token do cliente (company_token), uma única vez.
6. Com os dois tokens, você lê, página a página, as vendas e recebimentos.

Rotas

Método	Rota	O que faz	Autenticação
POST	/oauth/token	Troca client_id e client_secret por um token de 10 minutos	Credenciais da software house
POST	/v1/access-requests	Pede acesso aos dados de um cliente pelo CNPJ	Bearer
GET	/v1/access-requests/{cnpj}	Situação do pedido; entrega o token do cliente uma vez	Bearer
POST	/v1/access-requests/{cnpj}/reissue	Gera um token do cliente novo, se você perdeu o anterior	Bearer
GET	/v1/sales	Vendas alteradas desde uma data, por página	Bearer + X-Company-Token
GET	/v1/payments	Recebimentos alterados desde uma data, por página	Bearer + X-Company-Token

URL base

A URL de produção é enviada junto com as suas credenciais. Nos exemplos desta documentação ela aparece como $BASE_URL:

export BASE_URL="https://<url-enviada-pela-conciliamais>"

Todas as chamadas precisam ser feitas por HTTPS com TLS 1.2 ou mais recente. Conexões com TLS 1.0 ou 1.1 são recusadas antes de chegar à API. Uma chamada por http:// não é atendida: recebe só um redirecionamento 301 e nunca chega à API. Não siga esse redirecionamento: corrija a URL e troque as credenciais que foram enviadas sem criptografia.