Hera User Integrations

Atenção

Este módulo de integração via API REST permite que sistemas externos se comuniquem de forma segura e estruturada com os recursos disponíveis na plataforma.

Ideal para desenvolvedores, equipes técnicas ou integrações com ferramentas de terceiros que necessitam enviar ou consultar dados da sua conta de forma automatizada.

✅ Requer autenticação (Bearer Token, Api Key ou No authentication)
🚀 Compatível com JSON (application/json)

A seguir, apresentamos as instruções detalhadas de uso dos métodos GET e POST para comunicação com a API.

Propósito

As requisições GET e POST são os principais métodos HTTP utilizados para interagir com os recursos da API:

GET: utilizado para consultar ou listar informações.

POST: utilizado para criar novos registros ou enviar dados ao servidor.

Esses métodos permitem automatizar tarefas como:

✅ Buscar dados de clientes, pedidos, produtos, etc.
✅ Enviar formulários, criar cadastros, etc.

Etapas de Configuração

1. Obter Token de Autenticação

Para realizar requisições à API, é necessário um Token válido.

Como obter:

Acesse o Docs da API que você tenha interesse. 

Procure nós tópicos da documentação sobre Authorization, Authentication ou Token  

Siga o passo a passo orientado pela documento para gerar o token. 

Copie o Token e cole-o quando for pedido dentro do Hera User Integrations.

OBS:

Para aplicações que não usarem Token, use a opção "No Authentication". 

2. Requisição GET

Utilize o método GET para recuperar informações da API.

Exemplo de uso: Buscar todos os clientes cadastrados.

Method:

GET 

Url:

https://api.exemplo.com

Endpoint:

/v1/clientes/{{nome}}&{{email}}

Resposta esperada:

json

[  

    { "id": 1,    "nome": "Ana Souza",    "email": "ana@example.com"  },  

     {    "id": 2,    "nome": "Carlos Silva",    "email": "carlos@example.com"  } 

] 

Regras e Validações:

3. Requisição POST

Utilize o método POST para enviar dados ou criar novos registros.

Exemplo de uso: Criar um novo cliente.

Method:

POST 

Url:

https://api.exemplo.com

Endpoint:

/v1/clientes

Corpo da requisição:

{  "nome": "Joana Lima",  "email": "joana@example.com" } 

Resposta esperada:

{  "id": 3,  "nome": "Joana Lima",  "email": "joana@example.com",  "criado_em": "2025-07-16T14:23:00Z" } 

Regras e Validações: