Visão Geral
A API Cakto utiliza o protocolo OAuth2 para autenticar requisições. Neste guia, você aprenderá como obter um token de acesso e usá-lo para autenticar suas chamadas à API.Fluxo de Autenticação
Esse é o fluxo básico para autenticar suas requisições, mais adiante detalharemos cada etapa:1
Criar Chave de API
Crie uma Chave de API (
client_id e client_secret) no painel da Cakto2
Solicitar Token
Envie uma requisição POST para o endpoint de token com suas credenciais
3
Usar Token
Inclua o token de acesso no header
Authorization de cada requisição1 - Criando Chaves de API
Para começar a usar a API Cakto, você precisa criar suas chaves de API. Siga estas etapas:-
Acesse o painel da Cakto e navegue até a seção Integrações depois Cakto API.

Painel Cakto: Integrações depois Cakto API.
- Clique em “Criar Chave de API”.
-
Preencha o formulário com um nome descritivo e selecione os escopos de acesso necessários.

Modal de criação da Chave de API com a seleção de escopos.
-
Salve o
client_ide oclient_secretgerados após finalizar a criação, especialmente o client_secret que será exibido apenas nesse momento da criação.
2 - Solicitando Token de Acesso
Use este endpoint para trocar suas credenciais de API por um token de acesso OAuth2.Headers
string
default:"application/x-www-form-urlencoded"
required
application/x-www-form-urlencoded
Parâmetros do Corpo
string
required
O identificador único da sua aplicação
string
required
A chave secreta da sua aplicação (Fornecido apenas no momento da criação da chave de API)
Exemplo de Requisição
Resposta de Sucesso (200 OK)
string
Token JWT que deve ser usado no header Authorization das requisições
integer
Tempo de validade do token em segundos (exemplo: 36000 = 10 horas)
string
Tipo do token, sempre “Bearer”
string
Escopos de acesso concedidos ao token, separados por espaço. Exemplo:
read write productsErros Comuns
400 Bad Request - Escopo Inválido
400 Bad Request - Escopo Inválido
3 - Usando o Token de Acesso
Após obter o token, inclua-o no headerAuthorization de todas as requisições à API:
Exemplo de Requisição Autenticada
Expiração do Token
Tokens de acesso expiram após determinado tempo, retornado na resposta de autenticação no campoexpires_in. Após a expiração, outro token deve ser solicitado, não existe um endpoint para renovação.
Escopos de Acesso
Os escopos controlam quais recursos e operações sua aplicação pode acessar:
Os scopos
read e write definem o nível de permissão do token, para leitura read e/ou escrita write.
Outros escopos como products e offers definem quais recursos específicos o token pode acessar.
Segurança
Melhores Práticas
Armazenamento Seguro de Credenciais
Armazenamento Seguro de Credenciais
- Armazene
client_secretem variáveis de ambiente - Nunca commite credenciais no controle de versão (git)
- Armazene tokens de forma segura, não exponha em código client-side
Princípio do Menor Privilégio
Princípio do Menor Privilégio
- Solicite apenas os escopos necessários
- Crie chaves de API separadas para diferentes aplicações
- Revise e atualize permissões regularmente
Exemplos de Clientes
Python
Python
JavaScript/TypeScript
JavaScript/TypeScript
Próximos Passos
Introdução
Voltar para a visão geral da API
Referência da API
Explore todos os endpoints disponíveis