Documentação da API pública Sigalei
Bem-vindo à documentação da API pública da Sigalei!
Nossa API pública foi projetada para fornecer acesso fácil e seguro a recursos essenciais da nossa plataforma. Aqui você encontrará todas as informações necessárias para começar a desenvolver aplicativos, integrar serviços e explorar todas as funcionalidades oferecidas.
Nossa documentação foi elaborada com o objetivo de oferecer um guia completo para você aproveitar ao máximo nossa API pública. Incluímos detalhes técnicos, exemplos de código, endpoints disponíveis, parâmetros de solicitação e resposta, autenticação e autorização, além de melhores práticas para uma integração bem-sucedida.
Divirta-se explorando nossa API pública e aproveite ao máximo todos os recursos disponíveis!
O que é uma API GraphQL?
GraphQL é uma linguagem de consulta e manipulação de dados poderosa e flexível, projetada para fornecer uma abordagem eficiente e intuitiva para solicitar e fornecer dados em um formato estruturado. Com a API GraphQL, você pode especificar exatamente quais dados precisa em uma única solicitação, evitando problemas comuns de sub e superbusca de dados em APIs tradicionais REST.
Em vez de múltiplas chamadas a diferentes endpoints para obter informações específicas, você pode usar uma única solicitação GraphQL para buscar os dados necessários, obtendo uma resposta personalizada com exatamente o que precisa.
Utilizando a ferramenta Playground
Para facilitar a exploração e teste da nossa API GraphQL, fornecemos a ferramenta Playground. O Playground é um ambiente interativo onde você pode construir e executar suas consultas GraphQL em tempo real. É uma ótima maneira de experimentar e entender a estrutura da nossa API antes de integrá-la ao seu próprio código.
Para começar, acesse o Playground através deste link. Você será recebido com uma interface amigável e intuitiva que permite escrever e executar consultas GraphQL.
No painel esquerdo, você pode escrever suas consultas e mutações GraphQL. À medida que você digita, o Playground fornecerá sugestões automáticas de campos e estruturas disponíveis na nossa API, facilitando a construção de consultas corretas e eficientes.
No painel direito, você verá a resposta em tempo real da sua consulta. Isso permitirá que você veja os dados retornados pela API e verifique se estão de acordo com suas expectativas.