📘 Documentação Neppo Chat API | 🏠 Visão Geral (índice) · 🔎 Guia de Busca · 📦 Modelos de Dados
- O que você pode fazer com este módulo
- Exemplo de chamada
- Referência técnica completa
- V1 — main-controller (1 endpoints)
O que é este módulo?
Endpoint principal de health check da API — verifica se a plataforma está operacional.
| Quem usa | Times de DevOps, monitoramento, load balancers. |
|---|---|
| Problema que resolve | Sem health check, não é possível monitorar automaticamente se a API está disponível ou configurar alertas de indisponibilidade. |
| Impacto na experiência do cliente | A empresa detecta problemas de disponibilidade antes que os clientes percebam, minimizando o impacto. |
O que você pode fazer com este módulo
| Operação | O que faz (em linguagem simples) |
|---|---|
| Health check | Retorna o status de saúde da aplicação e suas dependências. |
Exemplo de chamada
Substitua SEU_TOKEN_AQUI pelo Bearer token obtido via OAuth2.
curl -X GET "https://hml-chat-api.neppo.com.br/" \
-H "Authorization: Bearer SEU_TOKEN_AQUI"
Exemplo de resposta (200 OK):
{}Valores ilustrativos (esqueleto do schema). Os campos retornados seguem o modelo de dados do recurso.
Referência técnica completa
V1 — main-controller (1 endpoints)
/
main · operationId: mainUsingGET
Auth: Application & Application User
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization | header | string | Não | Bearer token |
Respostas
| Código | Descrição | Schema |
|---|---|---|
| 200 | OK | object |
| 401 | Unauthorized | — |
| 403 | Forbidden | — |
| 404 | Not Found | — |
Exemplo de resposta (200 OK):
{}
Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0
Comentários
0 comentário
Escreva seu comentário aqui
Por favor, entre para comentar.