Testando a API localmente
Como receber callbacks de equipamentos em uma máquina de desenvolvimento e testar os comandos REST com o Postman antes de publicar.
Testes locais (sem publicar em um servidor)
Para testar a integração de callback a partir da sua máquina de desenvolvimento local, sem publicar em um servidor de produção, você precisa tornar a sua máquina acessível pela internet para que o Cams Protocol Engine consiga enviar (POST) os dados do callback a ela.
Opção A: IP público + redirecionamento de portas
Se a sua conexão de internet tem um endereço IP público (estático), você pode redirecionar uma porta externa para a sua aplicação local.
Descubra seu IP público
Acesse whatismyip.com ou execute curl ifconfig.me no terminal. Anote o seu endereço IP público.
Configure o redirecionamento de portas no roteador
Faça login no painel de administração do roteador. Redirecione uma porta externa (p. ex. 8080) para o IP interno da sua máquina e para a porta em que sua aplicação está rodando (p. ex. 3000, 5000, 8080).
Configure a URL de callback
No API Monitor, defina a sua URL de callback como:http://YOUR_PUBLIC_IP:8080/callback
Teste
Gere uma marcação no equipamento biométrico. O Cams Protocol Engine enviará (POST) os dados do callback ao seu IP público, que o roteador encaminha para a sua aplicação local.
Opção B: Ferramentas de túnel (sem IP público)
Se você não tem um IP público ou não consegue configurar o redirecionamento de portas, use um serviço de túnel para expor o seu servidor local à internet.
| Ferramenta | Comando | Observações |
|---|---|---|
| ngrok | ngrok http 3000 | Plano gratuito disponível. Fornece uma URL HTTPS pública na hora. |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | Gratuito. Não é necessária conta para túneis rápidos. |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | Sem instalação. Funciona via SSH. |
Inicie sua aplicação local
Execute o seu servidor de callbacks localmente (p. ex. php -S localhost:8080 ou node server.js ou python app.py).
Inicie o túnel
Execute a ferramenta de túnel. Ela exibirá uma URL pública como https://abc123.ngrok-free.app.
Configure a URL de callback
No API Monitor, defina a URL de callback com a URL do túnel:https://abc123.ngrok-free.app/callback
Teste
Gere uma marcação. Os callbacks chegarão à sua máquina local pelo túnel em tempo real.
Teste de URL
Antes de entrar em produção, verifique seus endpoints com o Postman. Oferecemos uma coleção pronta com todas as 27 operações RESTful pré-configuradas.
Coleção do Postman
Baixe e importe no Postman. Defina as variáveis base_url, stgid e auth_token e comece a testar imediatamente.
Importe a coleção
Abra o Postman → Import → arraste e solte o arquivo .json baixado. Todas as 27 operações RESTful aparecem agrupadas por categoria.
Defina suas variáveis
Vá até a aba Variables da coleção e defina:
base_url = a URL do seu endpoint RESTful (do API Monitor)
stgid = o Service Tag ID do seu equipamento
auth_token = o AuthToken do seu equipamento
Envie requisições
Selecione qualquer operação, edite o corpo JSON com seus valores e clique em Send. Verifique se a resposta corresponde ao formato esperado documentado acima.
Exemplo no Postman
Abaixo há uma captura de tela com um exemplo de requisição de API configurada no Postman. Defina o método como POST, cole a URL do seu endpoint RESTful com ?stgid= e use um corpo raw JSON.
{"status":"done"} com HTTP 200.