APIXdocs

Chaves de API

Toda chamada em nome do vendedor é autenticada por uma chave criada no painel. Existem dois tipos: chave secreta e par de chaves.

Dois tipos de chave

TipoComo autenticaQuando usar
Chave secretaHeader X-API-Key com o segredo pk_live_…Integração rápida; o segredo trafega em toda chamada
Par de chavesVocê assina cada requisição com a chave privadaRecomendado: o segredo nunca sai do seu servidor e a requisição não pode ser reenviada

As duas valem nas mesmas rotas. Veja chave assinada para o segundo tipo.

Chave secreta

Crie em Integrações & APIs no painel. O segredo aparece uma única vez.

Header
X-API-Key: pk_live_a1b2c3d4...
Use apenas no seu servidor. Uma chave exposta no navegador ou no aplicativo permite criar cobranças e pedir saques em seu nome.

Permissões

Cada chave carrega as permissões escolhidas no cadastro. Sem a permissão, a rota responde 403.

PermissãoLibera
salesCriar cobranças e consultar pagamentos
balance:readConsultar o saldo da conta
withdraw:createPedir saques e consultar um saque

IPs autorizados

Você pode restringir a chave a uma lista de IPs. A comparação é exata: se o seu servidor sai por IPv6, cadastre o endereço IPv6 (dá para cadastrar IPv4 e IPv6 na mesma chave). Fora da lista, a resposta é 403. Na chave assinada, informar ao menos um IP é obrigatório.

Limites e erros

SituaçãoResposta
Chave ausente401 · API key não fornecida
Chave inválida, pausada ou revogada401
Vendedor bloqueado401
IP fora da lista403
Permissão faltando403 · Esta API key não possui a permissão '…'
Mais de 10 chaves ativas400 no momento de criar
Testar a chave (consulta de saldo)
curl "https://api.apix.tec.br/@seller/withdraw/balance" -H "X-API-Key: pk_live_a1b2c3d4..."