1. Comece por aqui
  • Raiz
    • Comece por aqui
      • Teste de integridade
        GET
      • Autenticação — minha conta
        GET
    • Tabelas
      • Listar tabelas de operação
    • Propostas
      • Digitar proposta
      • Listar propostas
      • Consultar proposta
      • Linha do tempo da proposta
    • Tempo real
      • Status em tempo real (SSE)
    • Webhooks
      • Registrar webhook
      • Listar webhooks
      • Remover webhook
      • Disparar teste
      • Histórico de entregas
    • MCP (integração com IA)
      • Integrar com IA — Servidor MCP
  • Esquemas
    • Fase
    • TipoEvento
    • Evento
    • NovaProposta
    • Proposta
  1. Comece por aqui

Teste de integridade

Sandbox
http://localhost:4500/api/v1
Sandbox
http://localhost:4500/api/v1
GET
/ping
Verifica se a API, o banco de dados e a sua chave estão operacionais. Use como primeiro passo da integração.

Requisição

Nenhum

Respostas

🟢200OK
application/json
Tudo operacional
Bodyapplication/json

🟠401Não Autorizado
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://localhost:4500/api/v1/ping'
Response Response Example
200 - Exemplo de Sucesso
{
    "status": "ok",
    "ambiente": "sandbox",
    "banco_de_dados": {
        "status": "ok",
        "latencia_ms": 2
    },
    "empresa": "Parceira Alfa Promotora LTDA",
    "chave": "nxx_sb_dbed8e6...48d5",
    "timestamp": "2026-07-08T00:45:00.000Z"
}
Modificado em 2026-07-08 01:52:25
Próxima página
Autenticação — minha conta
Built with