Logo

Autenticação

Como autenticar suas requisições na API da Paggpix.

Todas as requisições à API da Paggpix precisam ser autenticadas com um par de credenciais (client_id e client_secret) enviado no cabeçalho Authorization, no formato Basic.

Base URL

Todas as requisições devem ser feitas para:

https://public-api.paggpix.com

Obtendo suas credenciais

A Paggpix fornece duas credenciais durante o onboarding:

  • client_id: identifica sua aplicação.
  • client_secret: a senha correspondente.

Para obtê-las, entre em contato com o time comercial ou de onboarding da Paggpix.

Trate o client_secret como uma senha. Nunca o exponha em código de frontend, repositórios públicos ou logs.

Montando o cabeçalho

Concatene as credenciais separadas por dois-pontos, codifique o resultado em Base64 e envie no cabeçalho Authorization com o prefixo Basic:

Basic base64(client_id + ":" + client_secret)
printf '%s' "$CLIENT_ID:$CLIENT_SECRET" | base64
const credentials = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
const authorization = `Basic ${credentials}`;

A maioria dos clientes HTTP monta esse cabeçalho para você. Com cURL, use a flag -u:

curl -u "$CLIENT_ID:$CLIENT_SECRET" https://public-api.paggpix.com/accounts/me

Exemplo de requisição autenticada

GET /accounts/me HTTP/1.1
Host: public-api.paggpix.com
Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=

O valor Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ= acima é apenas o Base64 da string literal client_id:client_secret. Substitua-o pelas suas credenciais.

Erros de autenticação

Requisições sem o cabeçalho Authorization, com credenciais malformadas ou com um client_secret incorreto retornam 401 Unauthorized. Veja Erros.

On this page