Integração Flexível com APIs

Nossa plataforma disponibiliza várias APIs (Interface de Programação de Aplicações) - API Pública, API Custom e StoreFront API - para facilitar a integração com diversos sistemas como de frete, meios de pagamento, ERPs, Marketplaces, CRMs, soluções de marketing, personalização e outros.

Nosso objetivo é proporcionar total liberdade para integrar o que você desejar, quando desejar, utilizando nossas APIs.

Além disso, oferecemos mais segurança com nossas APIs através da geração de múltiplos tokens. Cada aplicação pode ter seu próprio token de acesso, e cada token é criado com um propósito específico.

Por exemplo, se uma aplicação só precisa consultar pedidos, seu token estará configurado apenas com essa permissão. Isso significa que essa aplicação não terá acesso a outros métodos de integração disponíveis na plataforma.

O Portal para Desenvolvedores contém toda a documentação técnica referente às APIs disponíveis, listando todos os tópicos com detalhes, instruções de uso e autenticação.

A autenticação da API é realizada por meio da informação do token, assim é verificado a identidade do lojista/integrador e validado sua permissão para acessar determinada informação.

Gerando um token

Para criar um token acesse o menu Extensões e Integrações > Tokens e selecione a opção “Novo Token”.

Configuração do Token de Integração

Ao criar um novo token de integração é preciso preencher configurações básicas de cadastro, sendo elas:

• Nome do Token: Defina um nome que identifique a aplicação que utilizará o token. Esse nome será exibido na timeline dos pedidos sempre que uma alteração for realizada via API, facilitando a identificação da origem da ação.
• E-mail do Responsável Técnico: Informe o e-mail do responsável técnico pela integração. Esse contato será utilizado para comunicações relacionadas à segurança, suporte e manutenção do token. Para múltiplos contatos, separe por ponto e vírgula (;)
• Data de Expiração do Token: Escolha por quanto tempo o token será válido para integração na API. O limite máximo é de 1 ano. Recomendamos renová-lo a cada 90 dias para maior segurança. 
• Token: É gerado automaticamente ao salvar o cadastro. A chave é de visualização única, portanto, copie e guarde-a em um local seguro pois não será exibida novamente.

Após preencher as configurações, você encontrará as opções de permissões e poderá selecionar quais delas esse token terá acesso durante a integração com as APIs.

• Seleção de Permissões: Selecione as permissões que o token terá acesso. Dessa forma, ele poderá acessar apenas as informações necessárias para sua funcionalidade, garantindo mais segurança e controle.

Para facilitar a seleção dos endpoints, é possível filtrar por tipos, sendo eles: GET, PUT, POST, PATCH e DELETE. Dessa forma, são exibidos exatamente os endpoints pelo tipo filtrado. Além disso, é possível buscar pelo nome ou descrição do endpoint.

A opção “Ações” permite a expansão de todos os endpoints existentes, assim como o recolhimento para otimizar a seleção, que pode ser realizada de forma massiva. 

Gerenciando Tokens de Integração

Após selecionar as permissões desejadas, clique em "Salvar Token". Você verá uma mensagem confirmando que o token foi criado com sucesso e poderá copiar o token para salvá-lo em um local seguro, uma vez que a chave não é exibida novamente.

Importante: O token é confidencial! Uma vez copiado, salve a chave em um local seguro. Evite compartilhá-lo com pessoas não autorizadas para garantir a segurança da integração.

O processo de criação e gerenciamento de tokens é simples. Caso precise conceder mais acessos aos endpoints no futuro, basta clicar no ícone de “Ações” no token correspondente e selecionar as permissões adicionais necessárias.

Para facilitar a visualização dos tokens que estão com a data de expiração próximas ao vencimento, são exibidos ícones e cores diferentes diretamente na data de cada token. Dessa forma, é possível rotacionar o token diretamente na listagem.  

• Data laranja: Seu token irá expirar em 30 dias. Para maior segurança rotacione para gerar uma nova chave.

• Data vermelha: Próximo do limite de validade. Gere uma nova chave para manter suas integrações ativas.

Rotação de Token

Para garantir o funcionamento correto das integrações rotacione os tokens com data de expiração próximas ao vencimento. Dessa forma, a chave será atualizada para uma nova, mantendo as permissões já configuradas anteriormente. Além disso, é possível atualizar os dados como nome, nova data de expiração e os e-mails de responsável técnico para o token que está sendo rotacionado.

PONTOS DE ATENÇÃO:

• Tokens sem uso durante o período de 30 dias são inativados automaticamente.

• Tokens com data expirada são inativados automaticamente. 

• A antiga chave de um token rotacionado é inativada automaticamente. 

Os tokens inativados podem ser visualizados diretamente na listagem, na aba de inativos.

Testando o Token de Integração

Para verificar se o token está funcionando corretamente, siga estes passos:

• 1. Copie o Token: Primeiro, copie o token gerado no momento da criação.
• 2. Portal para Desenvolvedores:
  • Acesse o Portal para Desenvolvedores.
  • Vá para a aba "Referências de API", seção "Authentication - Header".
  • Cole o token na área designada para validação e teste do endpoint.
• 3. Teste com Método GET:
  • Você também pode realizar um teste utilizando o método GET.
  • No endpoint desejado clique no botão "Try it out!".
  • Isso executará uma consulta para verificar se a integração está funcionando corretamente.

Esses passos ajudarão você a confirmar se o token está configurado adequadamente e se a integração está operacional.

Controle de Requisições

Para otimizar o desempenho, nossa plataforma controla o número de requisições por minuto que cada aplicação pode fazer. Isso garante alta disponibilidade e evita sobrecarga na API devido a um grande volume de requisições.

Para mais detalhes e informações sobre limites de requisições, consulte o Portal para Desenvolvedores. Estamos à disposição para esclarecer qualquer dúvida que você possa ter!

Dúvidas Frequentes (FAQ):

• Para consultar as dúvidas mais comuns sobre a API de Integração, clique aqui.