Credenciais e Autorização

Nesta página você encontra informações sobre credenciais e autorização da API i9GiftCard

Rota base

Ambiente Rota base
Produção https://api.i9giftcard.com

Autorização com OAuth2

O mecanismo de permissão das solicitações feitas à API i9GiftCard é compatível com o protocolo OAuth2. Isso significa que ele segue um conjunto de regras e padrões para autorizar as requisições feitas à API.

O objetivo do OAuth2

Para autorizar todas as chamadas feitas à API, é necessário obter um token de acesso (access_token). Esse token é usado para verificar se uma determinada aplicação tem permissão para utilizar o endpoint solicitado na API.

Como é feita a autenticação das requisições

A autenticação é realizada usando HTTP Basic Auth, que requer o Client ID e Secret Key da aplicação que você criou na sua conta i9GiftCard. Com essa autenticação, o OAuth pode fornecer as informações sobre as permissões concedidas à aplicação, permitindo autorizar ou negar as solicitações com base nessa informação.

Obtendo as credenciais da aplicação

Um integrador pode criar quantas aplicações desejar. Para cada aplicação são gerados 2 pares de chaves Client ID e Secret Key
Utilizando a API i9GiftCard, o integrador pode gerar transações Pix (pagamentos e recebimentos), configurar Webhooks para o recebimento de notificações via callbacks e acessar as funcionalidades exclusivas da Conta i9GiftCard. Para isso, é necessário ativar os escopos necessários em sua aplicação.

Entendendo os escopos de aplicação

Ao criar ou editar uma aplicação em sua Conta i9GiftCard, você precisará configurar os escopos que a aplicação terá acesso. A escolha desses escopos define quais ações uma aplicação estará autorizada a realizar via API.
Escopo Descrição
account.read Permite exibir os dados da sua conta.
account_sake.read Permite exibir o saldo da conta.
account_sales.read Permite listar suas vendas.
account_reports.read Permite exibir seus relatórios.
customers.post Permite criar cliente.
customers.get Permite buscar clientes.
customers.read Permite obter dados de um cliente.
customers.write Permite atualizar dados de um cliente.
giftcard.get Permite consultar um Gift Card
giftcard.post Permite cobrancça imediatas com Gift Card
giftcard.read Listar cobranças executadas com Gift Cards.
giftcard.list Listar Gift Cards com links disponíveis para compra.
payments.post Permite criar um pagamento.
payments.get Permite buscar um pagamento.
payments.read Permite obter pagamentos.
payments.write Permite deletar um pagamento.
sake.post Permite solicitar saque via pix para sua conta.
sake.get Permite consultar status de um saque.
sake.write Permite solicitar saque para um cliente!
sake.read Permite consultar status de um saque do cliente.

Obter Autorização

POST /oauth/token
Certifique-se de ter uma conta ativa e suas credenciais em mãos!
GERAR TOKEN

HEADER

Authorization Basic Auth string obrigatório
Token de autorização a ser usado nas outras requisições feitas à API.

CREDENCIAIS

APP_ID string
ID do aplicativo ativo gerado em sua conta.
APP_TOKEN string
TOKEN do aplicativo ativo gerado em sua conta.
PD9waHAKCiRBcHBJRCA9ICd7QVBQX0lEfSc7CiRTZWNyZXRLZXkgPSAne0FQUF9UT0tFTn0nOwokYXV0b3JpemFjYW8gPSAgYmFzZTY0X2VuY29kZSgkQXBwSUQgLiAiOiIgLiAkU2VjcmV0S2V5KTsKJGZpZWxkcyA9IFsKCSdncmFudF90eXBlJyA9PiAnY2xpZW50X2NyZWRlbnRpYWxzJywgCl07CiRoZWFkZXJzID0gYXJyYXkoCgknQXV0aG9yaXphdGlvbjogQmFzaWMgJy4kYXV0b3JpemFjYW8sCgknQ29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9qc29uJwopOwokY2ggPSBjdXJsX2luaXQoKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1VSTCwgJ3tBUElfVVJMfS9vYXV0aC90b2tlbicpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfSFRUUEhFQURFUiwgJGhlYWRlcnMpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUkVUVVJOVFJBTlNGRVIsIFRSVUUpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUE9TVCwgVFJVRSk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9DVVNUT01SRVFVRVNUICwgJ1BPU1QnKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1BPU1RGSUVMRFMsIGpzb25fZW5jb2RlKCRmaWVsZHMpKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1NTTF9WRVJJRllQRUVSLCBGQUxTRSk7CiRyZXNwb25zZSA9IGN1cmxfZXhlYygkY2gpOwkKY3VybF9jbG9zZSgkY2gpOwoKZWNobyAkcmVzcG9uc2U7Cj8+

Respostas possíveis

/* Esse exemplo de resposta de sucesso! */
{
  "access_token": "Dqcr18pTRANC0hR$A_1mzc41Blx3KM_7KRx5bv4m9DQ2FmTDYDLvXx4941jo$0VnWRhvP0LU4mWhcgi99NO9ATQXzpWV3Suq8sf5_RXHUFA5KDOT2jTEwHS2GvRqcga2axel79FGmHBlcxmPDpVrB6nBe2ul7I$tBQVJIUT2Pex6p74InzqWQyJ9XxnqGp$ASegfJ7Z$hTlXv$pNyzUA",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "account.read account_sake.read account_sales.read"
}
A tabela abaixo descreve os atributos presentes no JSON retornado.
  1. access_token  Token de autorização a ser usado nas outras requisições feitas à API.  string
  2. token_type  Tipo de autorização na qual o access_token deve ser usado Padrão: "Bearer".  string
  3. expires_in  Tempo de expiração do access_token em segundos. Padrão 3600.  int
  4. scope  Lista de escopos aos quais a aplicação autorizada possui acesso. Os escopos estão separados por espaço.  string

Última atualização em 23 de dez. de 2024

i9 Gitf Card
i9 Gitf Card seu gateway sem limites

Whatsapp +55 51 993710985
Atendimento 9h às 12h - 14h às 20h
© 2025 i9GiftCard - Todos os direitos reservados
Gerar autorização
Basic:

						
Política de Cookies

Os cookies nos permitem entender a forma como você navega pelas nossas páginas e manter o funcionamento delas. Com essas informações, fica mais fácil, rápido e seguro usar sua conta. Ao desativar certos cookies, é possível que você não consiga aproveitar alguns recursos dos nossos sites.

Confira para que eles servem: