Conceito
API significa Application Programming Interface (Interface de Programação de Aplicações). Em termos simples, uma API é o meio pelo qual dois sistemas diferentes se comunicam e trocam informações de forma padronizada e segura.
Pense na API como um garçom em um restaurante: você (o sistema A) faz um pedido ao garçom (a API), que leva sua solicitação para a cozinha (o sistema B) e traz de volta o que você pediu — sem que você precise entrar na cozinha.
A API da OmniChat
A API da OmniChat foi desenvolvida seguindo os padrões REST, amplamente reconhecidos no mercado. Suas características são:
Endpoints intuitivos: os nomes indicam claramente os recursos disponíveis.
Verbos HTTP: as operações utilizam os métodos padrão (GET, POST, PUT, DELETE).
Formato JSON: os corpos de requisição e resposta seguem o formato JSON.
Códigos de status HTTP: as respostas seguem os códigos padrão (200, 404, 500, etc.), facilitando a interpretação dos resultados.
Independente de linguagem: qualquer aplicação pode consumir a API, independentemente da linguagem de programação utilizada.
Como acessar a API OmniChat
Acesse a integração de API em: Configurações → Integrações → API
Para acessar a documentação completa, com exemplos e referências de endpoints, acesse: https://api-docs.omni.chat
Para obter sua chave de acesso (x-api-key), entre em contato com o suporte OmniChat em: Ajuda → Fale com a Gente
Dica: A chave de API é confidencial. Não a compartilhe com terceiros e mantenha-a em um local seguro no seu sistema.