Bem-vindo à documentação da nossa API! Esta documentação serve como um guia para desenvolvedores que desejam integrar seus aplicativos e sistemas com os recursos fornecidos pela nossa API. Aqui você encontrará informações detalhadas sobre os endpoints disponíveis, os parâmetros necessários, as respostas esperadas e exemplos de uso.

Sobre a API

A API REST do Celeti Hub oferece acesso a uma variedade de recursos e funcionalidades, permitindo que os desenvolvedores integrem nossos serviços de forma eficiente.

Como Usar Esta Documentação

Esta documentação está organizada para facilitar a compreensão e a utilização da API. Dividida em 3 seções: a seção “Guia”, onde cada página aborda um aspecto específico da API, incluindo uma descrição geral, os endpoints disponíveis e considerações importantes para a integração; a seção “Referência”, que aborda aspectos mais técnicos, como informações detalhadas sobre os endpoints (parâmetros das requisições, formatação e obrigatoriedade dos campos, respostas e exemplos de uso); e a seção “Atualizações”, que apresenta o changelog da API, reunindo as principais novidades, melhorias, alterações e correções realizadas ao longo das versões, permitindo acompanhar a evolução da API e identificar rapidamente mudanças que possam impactar a integração.

Autenticação

Para utilizar os endpoints da nossa API, é necessário autenticar suas requisições por meio de um bearer token.

A autenticação é realizada utilizando um token de acesso (access token) único por provedor, a partir do qual será gerado um bearer token com duração limitada por meio do nosso endpoint de autenticação (authenticate). Esse token deverá ser incluído no header (cabeçalho) Authorization de todas as requisições HTTP, utilizando o esquema Bearer.

Mais detalhes sobre o processo de autenticação estão disponíveis na página correspondente, dentro do menu Endpoints.

Callbacks

Fornecemos a possibilidade de utilizar callbacks que enviam dados de forma assíncrona sempre que um determinado evento ocorrer.

Consulte as orientações sobre como configurá-las na página “Callbacks”.

Ambientes

A API está disponível em dois ambientes diferentes para atender às necessidades de desenvolvimento/teste e produção.

Homologação

O ambiente de homologação pode ser usado para realizar testes de integração e garantir que o código funcione conforme o esperado em um ambiente simulado antes de ser implantado em produção.

Produção

O ambiente de produção é onde a API está em pleno funcionamento e atende aos usuários finais.

Suporte

Estamos aqui para ajudar! Se você tiver alguma dúvida ou problema relacionada à API, não hesite em entrar em contato com nossa equipe técnica!