<aside> <img src="/icons/map-pin_blue.svg" alt="/icons/map-pin_blue.svg" width="40px" />
</aside>
O Outpost é o principal meio de integração com a Core AI. Através dele, é possível enviar dados, realizar análises de crédito e efetuar operações de antecipação. Além disso, ele permite o fornecimento de informações detalhadas sobre essas operações de forma simples e eficiente, utilizando apenas alguns endpoints. Abaixo segue o diagrama de endpoints da API:
Para interagir com a API Outpost, o processo inicia-se pela autenticação para obter um token JWT de acesso, através do endpoint [POST] /auth/token para autenticação.
<aside> ⚠️
Um aspecto fundamental da nossa abordagem é a utilização de IDs próprios de identificação. Em vez de gerar códigos internos, adotamos identificadores do cliente para proporcionar:
Portanto, para interagir com o Outpost, basta utilizar IDs próprios, simplificando todo o processo.
</aside>
Todo pagamento é vinculado a um contrato. Para tanto, primeiramente é necessário criar um contrato, o que pode ser realizado por meio dos endpoints localizados em Contracts. Com o contrato criado, basta criar seus pagamentos, que podem ser realizados por meio dos endpoints de Billings. Os dados fornecidos aqui são cruciais para a análise de elegibilidade para antecipação e ajuste das taxas de desconto.
Fluxo de Solicitação**:**
Após a antecipação, a gestão dos repasses é feita pelo endpoint [POST] /core_split.
A API também oferece recursos para a gestão de usuários e permissões:
O Webhook é disparado automaticamente sempre que ocorre uma mudança de status em uma requisição de antecipação.
Para garantir a segurança da integração, todas as notificações enviadas incluem uma assinatura HMAC no cabeçalho da requisição. Essa assinatura é gerada a partir de uma chave secreta compartilhada entre os sistemas, permitindo que o receptor valide a autenticidade e a integridade da mensagem recebida.
As credenciais necessárias para gerar e validar a assinatura são específicas para cada ambiente (staging e production) e podem ser obtidas no Watchtower, na aba Desenvolvedores. É essencial manter essa chave segura e renovar periodicamente quando necessário.