Integrações via API

Visão geral

A API aberta permite a integração da plataforma com sistemas e softwares externos de forma automatizada. Através da documentação técnica e da criação de credenciais de acesso, equipes de desenvolvimento conseguem estruturar requisições personalizadas e consultar as rotas disponíveis.

Quando usar este artigo

Utilize este artigo para localizar a documentação técnica oficial de integração via API, compreender como solicitar suporte ao time de desenvolvedores e obter direcionamento para a geração de credenciais de acesso (App e Access Token).

Sintoma ou cenário

Necessidade da equipe de tecnologia de conectar softwares terceiros ao sistema, consultar endpoints disponíveis ou esclarecer dúvidas sobre requisições com a equipe técnica.

Benefício para o usuário ou operação

Automação do fluxo de dados entre o sistema e plataformas externas por meio de endpoints padronizados;
Orientação técnica centralizada na base de documentação para desenvolvedores;
Canal de atendimento direto via e-mail (api@superlogica.com) para suporte especializado em integrações.

Onde acessar / contexto de uso

Acesse a documentação técnica externa ou o menu de configurações da conta para gerenciamento de credenciais de integração.

Pré-requisitos (Antes de começar)

Perfil Exato: Usuário com permissão de acesso administrativo (1000 - Acesso Administrativo) ou alteração em configurações (1061 - Configurações - Alteração).
Recursos Sistêmicos: Módulo de configurações ativo e permissão de acesso às opções de internet e integração.
Insumos e Dados Técnicos: Conhecimento técnico em desenvolvimento de sistemas, escopo da integração e credenciais de acesso ao sistema.

Causas prováveis

Necessidade de integrar a plataforma com ERPs proprietários, CRMs, lojas virtuais ou plataformas externas, além de consultas sobre retorno de chamadas de API.

Como fazer ou corrigir

O desenvolvimento de integrações via API exige a utilização da documentação técnica oficial para a construção de chamadas e a geração prévia das chaves de autenticação (App e Access Token) para autorização das requisições.

Acesse a documentação técnica oficial da API para consultar a lista completa de rotas, parâmetros e exemplos de requisição.
Para autenticar as chamadas da sua aplicação, siga o procedimento de criação de App e Access Token dentro do sistema.
Se surgirem dúvidas técnicas que não estejam detalhadas na documentação, envie uma mensagem para a equipe de desenvolvimento no e-mail api@superlogica.com.

Resultado esperado

O desenvolvedor acessa a documentação técnica, realiza a geração dos tokens de acesso e estabelece contato com o suporte especializado para concluir a integração.

Quando escalar

Escale a solicitação para a equipe técnica caso haja instabilidades no ambiente de API, retornos de erro inesperados nas chamadas de endpoints ou falhas na emissão das credenciais de acesso.

Informações que devem ser reunidas antes do escalonamento

Nome da licença;
Endpoint ou rota consultada e método HTTP utilizado (GET, POST, PUT, DELETE);
Código de retorno (HTTP status) e o payload completo de erro recebido;
E-mail e identificação do desenvolvedor responsável pela integração.

Regras importantes / Observações

Todas as requisições enviadas para a API exigem autenticação válida composta por App e Access Token;
O canal api@superlogica.com destina-se exclusivamente ao atendimento de dúvidas técnicas e de desenvolvimento relacionadas à API;
A documentação técnica deve ser consultada previamente para validação dos formatos de dados e parâmetros exigidos em cada rota.

Problemas comuns e como resolver

Problema: As requisições enviadas para a API retornam erro de acesso não autorizado (HTTP 401/403).
- Causa provável: O App ID ou o Access Token utilizado está incorreto, expirou ou não foi informado corretamente nos cabeçalhos da requisição.
- Ação recomendada: Verifique as credenciais geradas no sistema, reemita os tokens se necessário e confirme se o header da chamada contém as chaves exigidas.

Dúvidas relacionadas

P: Qual é o e-mail para tirar dúvidas técnicas sobre a integração via API? R: Dúvidas que não forem resolvidas pela documentação podem ser enviadas diretamente para o time de desenvolvimento pelo e-mail api@superlogica.com.

P: O que é necessário para autenticar uma aplicação na API do sistema? R: É necessário realizar a criação de um App e gerar um Access Token no sistema para enviar nas requisições.

Palavras-chave de busca

integração via API, documentação técnica API, criar app e access token, suporte a desenvolvedores, email de dev, endpoints