Toda requisição à API do SpherePay deve ser autenticada usando uma chave de API. O SpherePay usa autenticação por Bearer token — você passa sua chave no cabeçalho Authorization de cada requisição. Esta página explica como gerar uma chave, como usá-la e como lidar com erros de autenticação.
Obtenha sua chave de API
As chaves de API são geradas no painel do SpherePay:
- Acesse spherepay.co/dashboard.
- Navegue até Developers → API Keys.
- Selecione Create New API Key.
- Copie a chave imediatamente — ela não será exibida novamente depois que você sair da página.
Trate sua chave de API como uma senha. Nunca a exponha em código do lado do cliente, faça commit em controle de versão ou compartilhe em texto simples. Se uma chave for comprometida, revogue-a imediatamente no painel e gere uma nova.
Faça uma requisição autenticada
Passe sua chave de API como um Bearer token no cabeçalho Authorization em cada requisição:
curl https://api.spherepay.co/v2/customer \
-H "Authorization: Bearer YOUR_API_KEY"
Cabeçalhos da requisição
| Cabeçalho | Obrigatório | Valor |
|---|
Authorization | Sim | Bearer YOUR_API_KEY |
Content-Type | Sim para POST/PATCH | application/json |
Erros de autenticação
Se sua chave de API estiver ausente, malformada ou inválida, a API retorna uma resposta 403 Forbidden:
{
"status": 403,
"detail": "Forbidden resource",
"correlationId": "e633f28100526862cadc4c592435eddd"
}
- O cabeçalho
Authorization está formatado como Bearer YOUR_API_KEY com um único espaço entre Bearer e a chave — sem caracteres extras ou aspas.
- A chave não foi revogada. Acesse o painel em Developers → API Keys para verificar o status.
- Você está enviando a requisição por HTTPS, não HTTP.
