A API permite que o seu sistema converse diretamente com a plataforma: envio de pedidos, consulta de status e verificação de saldo, tudo automatizado. Este é o ponto de partida da integração.

1. Localize a sua chave de API

Toda conta possui uma chave de API exclusiva, disponível na área da sua conta dentro do painel. Essa chave identifica e autentica todas as requisições feitas em seu nome.

2. Solicite a ativação

Por segurança, o acesso via API não vem habilitado por padrão. Fale com o suporte informando o usuário da conta e solicitando a ativação da API. A liberação é rápida e feita uma única vez.

3. Consulte a documentação técnica

A página API dentro do painel traz a documentação completa e atualizada: endereço das requisições, parâmetros de cada operação e o formato das respostas. Use sempre essa página como referência oficial, pois é ela que reflete a versão atual da API.

Segurança da chave: leve a sério

A chave de API dá acesso ao seu saldo. Trate como uma senha:

• Nunca compartilhe a chave nem a publique em repositórios de código;
• Armazene em variáveis de ambiente ou arquivos de configuração fora do controle de versão;
• Nas integrações web, faça as chamadas sempre do seu servidor, nunca do navegador do usuário, onde a chave ficaria exposta;
• Em caso de suspeita de vazamento, solicite a troca da chave ao suporte imediatamente.

Próximo passo

Com a chave em mãos e o acesso ativado, veja o artigo Como enviar pedidos pela API para fazer sua primeira integração funcionar.