Documentação de API

15min

Introdução
﻿
Bem-vindo! Aqui você encontrará todos os detalhes para integração com o Klavi Link e as APIs de serviço. Se deseja ver um resumo basta ir ao Quickstart.
Glossário
﻿
Termo
Definição
Partner Code
Identificador único do parceiro para acessar a API e o Link, como um nome de usuário.
Partner Token
Token único do parceiro para atualização, como uma senha.
Link
Conjunto de páginas modulares em HTML que trabalham com autenticação de vários fatores (MFA, multi-factor authentication), senhas de uso único (OTP, one time password) e gerenciamento de erros.
Institution
As instituições financeiras disponíveis na conexão.
Callback URL
Página web ou app para redirecionamento do usuário quando a conexão bancária terminar.
Webhook
URL dedicado para receberem os dados bancários via API
Sandbox
Ambiente com dados de teste para entenderem como a solução funciona.
KYC
“Know your customer” ou conheça seu cliente.
Connection Key
Chave identificadora única por conexão de cada usuário. Ela será gerada após a primeira conexão e pode ser encontrado no arquivo JSON da conexão.
Chaves e acesso
﻿
Algumas chaves são necessárias para usar nossa API. Você receberá as chaves do Sandbox pelo dashboard. Chaves de ambiente de homologação e produção são enviadas separadamente.
Protocolos de API
﻿
Nossa API usa o método POST para enviar dados bancários em formato JSON. Todos os envios devem incluir um “Content-Type application/json” e o corpo deve ser um JSON válido. Usamos HTTPS TLS v1.2 para garantir a segurança dos dados e códigos de respostas.
Hospedagem de API
﻿
﻿https://api-sandbox.klavi.ai(Sandbox)
https://api-test.klavi.ai (Homologação)
(Produção, consultar com a Klavi)
Endpoints
﻿
Atualização automática
Text
|
account/v1/autoupdate_sync
account/v1/autoupdate_config
account/v1/autoupdate_sync
account/v1/autoupdate_config
﻿
Deleção de conta
Text
|
account/v1/delete
account/v1/delete
﻿
Reacções Da Categoria
Text
|
transaction/v2/category_feedback
transaction/v2/category_feedback
﻿
Codificação de caracteres
﻿
Usamos UTF-8 em todos os casos.
Segurança
﻿
Conexões bancárias em modo de visualização - não conseguimos fazer transações;
Protocolo de criptografía TLS 1.2 para garantir segurança de comunicação na rede;
Dados sensíveis são criptografados com RSA 1024-bit para proteção de privacidade.
Para mais detalhes sobre segurança da informação, acesse https://klavi.ai/security.
﻿

Uso do Console

Produtos

Docs powered by

Archbee

TABLE OF CONTENTS

Codificação de caracteres

Segurança

Termo	Definição
Partner Code	Identificador único do parceiro para acessar a API e o Link, como um nome de usuário.
Partner Token	Token único do parceiro para atualização, como uma senha.
Link	Conjunto de páginas modulares em HTML que trabalham com autenticação de vários fatores (MFA, multi-factor authentication), senhas de uso único (OTP, one time password) e gerenciamento de erros.
Institution	As instituições financeiras disponíveis na conexão.
Callback URL	Página web ou app para redirecionamento do usuário quando a conexão bancária terminar.
Webhook	URL dedicado para receberem os dados bancários via API
Sandbox	Ambiente com dados de teste para entenderem como a solução funciona.
KYC	“Know your customer” ou conheça seu cliente.
Connection Key	Chave identificadora única por conexão de cada usuário. Ela será gerada após a primeira conexão e pode ser encontrado no arquivo JSON da conexão.