Obter token de acesso

POST /token

Método utilizado para obter o token de acesso que deverá ser utilizado nas próximas requisições à API.
Para utilizar esse método, você deverá enviar o header de autenticação conforme explicado neste item.

Dados da requisição

Nome

Tipo

Obrigatório

Explicação

grant_type

string 30 caracteres

Sim

Tipo da permissão

Valor	Explicação
authorization_code	Código de autorização

scope

string 500 caracteres

Sim

Escopo da requisição.
Separe cada item por espaço

Valor	Explicação
customers.read	Clientes: Apenas leitura
customers.write	Clientes: Apenas escrita
plans.read	Planos: Apenas leitura
plans.write	Planos: Apenas escrita
cards.read	Cartões: Apenas leitura
cards.write	Cartões: Apenas escrita
subscriptions.read	Assinaturas: Apenas leitura
subscriptions.write	Assinaturas: Apenas escrita
charges.read	Cobranças Avulsas: Apenas leitura
charges.write	Cobranças Avulsas: Apenas escrita
transactions.read	Transações: Apenas leitura
transactions.write	Transações: Apenas escrita
card-brands.read	Bandeiras de cartões: Apenas leitura
carnes.read	Carnês: Apenas leitura
boletos.read	Boletos: Apenas leitura
payment-methods.read	Formas de pagamento: Apenas leitura
webhooks.write	Webhooks: Apenas escrita
pos.write	Pos: Apenas escrita
releases.read	Releases: Apenas leitura

URL da Requisição

https://api.sandbox.cel.cash/v2/token

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "access_token": "a2f25405ed3917e6d2cdb66ef8130217",
    "token_type": "Bearer",
    "expires_in": 600,
    "scope": "customers.read customers.write plans.read plans.write transactions.read transactions.write webhooks.write balance.read balance.write cards.read cards.write card-brands.read subscriptions.read subscriptions.write charges.read charges.write boletos.read"
}

Nome

Tipo

Explicação

access_token

string 255 caracteres

Token de acesso.

token_type

string 30 caracteres

Tipo de autenticação do token.

expires_in

int 11 dígitos

Tempo de expiração em segundos do token.

scope

string 255 caracteres

Escopo da requisição.

Valor

Explicação

Opções válidas para Clientes:

customers.read

Clientes: Apenas leitura

customers.write

Clientes: Apenas escrita

Opções válidas para Planos:

plans.read

Planos: Apenas leitura

plans.write

Planos: Apenas escrita

Opções válidas para Cartões:

cards.read

Cartões: Apenas leitura

cards.write

Cartões: Apenas escrita

Opções válidas para Assinaturas:

subscriptions.read

Assinaturas: Apenas leitura

subscriptions.write

Assinaturas: Apenas escrita

Opções válidas para Cobranças avulsas:

charges.read

Cobranças Avulsas: Apenas leitura

charges.write

Cobranças Avulsas: Apenas escrita

Opções válidas para Transações:

transactions.read

Transações: Apenas leitura

transactions.write

Transações: Apenas escrita

Opções válidas para Bandeiras de cartões:

card-brands.read

Bandeiras de cartões: Apenas leitura

Opções válidas para Carnês:

carnes.read

Carnês: Apenas leitura

Opções válidas para Boletos:

boletos.read

Boletos: Apenas leitura

Opções válidas para Formas de pagamento:

payment-methods.read

Formas de pagamento: Apenas leitura

Opções válidas para Webhooks:

webhooks.write

Webhooks: Apenas escrita

Opções válidas para Pos:

pos.write

Pos: Apenas escrita

Opções válidas para Releases:

releases.read

Releases: Apenas leitura

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.