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 APICopied!

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çãoCopied!

Esta documentação está organizada de forma a facilitar a compreensão e a utilização da API. Dividida em 2 seções: esta 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; e 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)!

AutenticaçãoCopied!

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

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

Mais detalhes sobre o processo de autenticação serão fornecidos na página correspondente dentro do menu “Endpoints”.

CallbacksCopied!

Fornecemos a possibilidade de uso de duas callbacks que enviarão dados assincronamente sempre que um determinado evento ocorrer.

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

AmbientesCopied!

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.

URL Base: https://api.homologacao.celetihub.com.br

Produção

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

URL Base: https://api.celetihub.com.br

SuporteCopied!

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!