Pular para o conteúdo principal

Cadastros necessários

Antes da primeira chamada aos feeds, três coisas precisam existir. As duas primeiras são feitas uma vez; a terceira se repete para cada cliente.

#CadastroQuem fazResultado
1Software house no Concilia+Equipe Concilia+, a seu pedidoclient_id e client_secret
2Cliente no Concilia+O cliente, com o Concilia+Empresa ativa, com o CNPJ e as adquirentes conectadas
3Autorização do cliente para a sua software houseVocê pede, o cliente aprovacompany_token daquele cliente

1. Cadastro da software house​

O acesso à API Partner é liberado por e-mail. Escreva para a equipe do Concilia+ informando:

  • Nome da software house, como o cliente vai vê-lo no painel ao aprovar o pedido;
  • E-mail de contato técnico, que também aparece para o cliente junto com o pedido;
  • Volume esperado (quantos clientes e quantas chamadas por minuto), para definir o seu limite;
  • Validade do acesso, se houver (por exemplo, contrato até uma data).

O Concilia+ cadastra a software house e envia:

DadoFormatoExemplo
client_idci_ + 22 caracteresci_AbCdEfGhIjKlMnOpQrStUv
client_secretcs_ + 43 caracterescs_...
Limite por minutointeiro15 (padrão)
URL base da APIURL HTTPS

:::danger Guarde o client_secret com cuidado O client_secret é mostrado uma única vez e o Concilia+ não guarda o valor em claro. Guarde-o num cofre de segredos, nunca no código-fonte nem em logs. Se ele vazar ou se perder, peça uma chave nova: a anterior deixa de funcionar na hora, e os tokens já emitidos com ela também. :::

Não há liberação por IP: a API aceita chamadas de qualquer endereço. A proteção vem das credenciais, dos limites de uso e da validação rígida dos dados enviados.

O que pode mudar depois​

O Concilia+ pode, a seu pedido ou por segurança:

  • alterar o nome, o e-mail de contato, a validade e o limite por minuto (vale na hora);
  • trocar o client_secret: o antigo e os tokens já emitidos param de valer;
  • revogar a software house: nenhuma chamada é aceita, nem com tokens já emitidos. Se ela for reativada, as autorizações dos clientes voltam a valer.

2. Cliente cadastrado no Concilia+​

A API Partner só entrega dados de quem já é cliente do Concilia+. Para os feeds trazerem informação, o cliente precisa ter:

  • a empresa ativa, cadastrada com o CNPJ que você vai usar no pedido;
  • as contas das adquirentes conectadas (Rede, Stone, PagBank e/ou Cielo), para que as vendas e os recebimentos sejam sincronizados.

Cada CNPJ é uma empresa. Um grupo com vários CNPJs cadastrados como empresas separadas recebe um pedido por CNPJ, e você recebe um company_token para cada um. Uma aprovação cobre todos os estabelecimentos (PVs) e todas as adquirentes daquele CNPJ.

:::info A API não revela quem é cliente Por segurança, o pedido de acesso responde igual para qualquer CNPJ, seja cliente ou não. Combine com o seu cliente fora da API que ele usa o Concilia+ e que vai aprovar o pedido. :::

3. Autorização do cliente​

Para cada cliente:

  1. Você cria o pedido com POST /v1/access-requests, informando o CNPJ.
  2. O pedido aparece no painel do Concilia+ do cliente, com o nome e o e-mail da sua software house. Não é enviado e-mail ao cliente: avise-o para entrar no painel e aprovar.
  3. Um proprietário (perfil OWNER) da empresa aprova ou recusa. Outros perfis só veem o pedido.
  4. Você consulta GET /v1/access-requests/{cnpj} e, na primeira consulta após a aprovação, recebe o company_token.

Regras do pedido:

SituaçãoO que acontece
O cliente não responde em 7 diasO pedido vira EXPIRED. Você pode pedir de novo.
O cliente recusaO pedido vira DENIED. Por 30 dias a sua software house não consegue abrir um pedido novo para esse CNPJ (a API responde 202, mas não cria nada).
O cliente revoga um acesso aprovadoO company_token para de valer na hora. Você pode pedir de novo.
O Concilia+ revoga o acesso (suporte)Igual à revogação pelo cliente.
AprovadoNão expira. Vale até ser revogado.

:::danger O company_token também é entregue uma vez Guarde o company_token com o mesmo cuidado do client_secret, associado ao CNPJ do cliente. Se perder, use POST /v1/access-requests/{cnpj}/reissue: o cliente não precisa aprovar de novo. :::