Pular para o conteúdo principal

API de Integração

Francyne Leocadio
Atualizado

Banes de atualizações base.png

Integração Flexível com APIs

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

Objetivo da Integração:

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

Segurança Aumentada com Tokens Múltiplos:

    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.

Controle de Permissões:

 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.

 

Como facilitar a integração via API?

Facilitando Integrações com Nossa Plataforma

     Nossa plataforma oferece diversas APIs (como API Pública, API Custom e StoreFront API) que permitem integrar facilmente qualquer sistema, como sistemas de frete, meios de pagamento, ERPs, Marketplaces, CRMs, soluções de marketing, personalização, entre outros. 

     O Portal para Desenvolvedores lhe dará todas as informações.

Objetivo das APIs:

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

Segurança Reforçada com Tokens Múltiplos:

     Além disso, oferecemos mais segurança com nossas APIs permitindo a geração de múltiplos tokens. Cada aplicação pode ter seu próprio token de acesso, e cada token é configurado com permissões específicas.

Controle de Acesso:

     Por exemplo, se uma aplicação só precisa consultar pedidos, seu token será configurado apenas com essa permissão. Isso garante que essa aplicação não terá acesso a outras funcionalidades de integração disponíveis na plataforma.

   Na aba de Documentação, listamos todos os tópicos da API 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 e validado sua permissão para acessar determinada informação.

 

Gerando um token

   Para criar um token acesse o menu Configurações >> Integrações >> Tokens >> "+ Adicionar Token".

Configuração do Token de Integração

Ao editar editar.png um token de integração, você pode realizar algumas configurações importantes:

  1. Nome da Aplicação: Defina um nome para a aplicação que o token vai servir. Isso ajuda a identificar claramente qual aplicação está utilizando o token.

  2. Seleção de Permissões: Escolha quais permissões serão concedidas ao token. Isso garante que ele só terá acesso às informações autorizadas para sua funcionalidade específica.

  3. E-mail do Responsável Técnico: Informe o e-mail do responsável técnico. Este é um contato importante para questões relacionadas à integração e segurança do token.

 

    O token será gerado automaticamente. Logo abaixo, você encontrará as opções de permissões e poderá selecionar  quais delas esse token terá.

Gerenciando Tokens de Integração

Após selecionar as permissões desejadas, clique em "Salvar". Você verá uma mensagem confirmando que o token foi salvo com sucesso.

Para acessar o token novamente:

  1. Vá para as configurações administrativas e selecione "Token de Integração".
  2. Você encontrará o token gerado listado. Este token pode ser compartilhado com sua equipe de desenvolvimento e com aqueles que precisam acessar o suporte do seu ERP para integrar com nossa plataforma via API.

Importante: O token é confidencial. 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. Se precisar conceder mais acessos no futuro, basta clicar em "Editar" no token correspondente e selecionar as permissões adicionais necessárias.

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.

  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.
    • Dentro do 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.

Teste Importante para Integração

É essencial realizar esse teste para garantir que sua integração esteja funcionando sem problemas. Aqui estão os passos:

  1. Verificação de Funcionamento:

    • Durante o processo de integração, realizar esse teste ajuda a identificar qualquer problema ou dificuldade na sua API.

  2. 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.

 

Artigos relacionados