Introdução à API REST do Ravi Monitor

Visão Geral

A API REST do Ravi Monitor oferece acesso programático a todas as principais funcionalidades do sistema, permitindo integração com sistemas externos, automação de tarefas e desenvolvimento de aplicações customizadas.

Características Principais

Arquitetura RESTful

• Endpoints organizados por recursos
• Métodos HTTP padrão (GET, POST)
• Respostas em formato JSON
• Códigos de status HTTP apropriados

Autenticação por Token

• Sistema de tokens de acesso
• Permissões granulares por módulo
• Controle de acesso baseado em recursos

Módulos Disponíveis

• OLT: Gerenciamento de OLTs e ONTs
• DNS: Configuração de DNS autoritativo e recursivo
• WhatsApp: Envio de mensagens

URL Base

https://seu-servidor-ravi/api.php

Estrutura das Requisições

Parâmetros Obrigatórios

Todas as requisições devem incluir:

• token: Token de autenticação
• action: Módulo da API (olt, dns, whatsapp)
• operation: Operação específica do módulo

Exemplo de Requisição

curl -X POST "https://seu-servidor-ravi/api.php" \
  -d "token=SEU_TOKEN" \
  -d "action=olt" \
  -d "operation=search_olt" \
  -d "olt=1"

Formato de Resposta

Resposta de Sucesso

{
  "status": "success",
  "data": {
    // Dados específicos da operação
  }
}

Resposta de Erro

{
  "status": "error",
  "message": "Descrição do erro"
}

Resposta Direta (alguns endpoints)

{
  "msg": "ok"
}

Códigos de Status HTTP

• 200: Operação realizada com sucesso
• 400: Erro na requisição (parâmetros inválidos)
• 401: Token inválido ou não fornecido
• 403: Acesso negado (sem permissão para o módulo)
• 500: Erro interno do servidor

Headers Recomendados

Content-Type: application/x-www-form-urlencoded
Accept: application/json

Limitações e Considerações

Rate Limiting

• Não há limitação explícita de taxa implementada
• Recomenda-se uso responsável para evitar sobrecarga

Timeout

• Algumas operações podem levar tempo considerável
• Configure timeouts adequados em suas aplicações

Segurança

• Use sempre HTTPS em produção
• Mantenha os tokens seguros
• Monitore o uso da API

Próximos Passos

1. Configurar Autenticação - Obter e configurar tokens
2. API OLT - Gerenciar OLTs e ONTs
3. API DNS - Configurar DNS
4. API WhatsApp - Enviar mensagens
5. Códigos de Erro - Referência completa de erros

Nota: Esta API está em constante evolução. Verifique regularmente as atualizações da documentação para novos recursos e alterações.