API v1.0

Documentação da API PetroHost

Integre seus sistemas com nossa plataforma de hospedagem usando nossa API RESTful robusta, segura e bem documentada.

GET /api/v1/hosting
{
  "success": true,
  "data": [
    {
      "id": 1,
      "domain": "example.com.br",
      "status": "active",
      "plan": "Premium"
    }
  ]
}

Começando

A API PetroHost permite que você gerencie serviços de hospedagem, domínios, faturas e muito mais de forma programática.

Base URL
https://petrohost.com.br/api/v1/
Formato

Todas as requisições e respostas são em JSON

Formato de Resposta Padrão
JSON Response
{
  "success": true,
  "data": {
    // dados da resposta
  },
  "message": "Operação realizada com sucesso",
  "timestamp": "2024-01-20T10:30:00Z"
}

🔐 Autenticação

A API PetroHost usa autenticação via Bearer Token. Você pode gerar seu token de acesso no painel de controle.

Header de Autenticação

Authorization: Bearer SEU_TOKEN_AQUI
Importante: Mantenha seu token seguro e nunca o compartilhe publicamente.

📋 Visão Geral dos Endpoints

Método Endpoint Descrição
GET /user Obter informações do usuário
GET /hosting Listar serviços de hospedagem
POST /hosting Criar novo serviço de hospedagem
GET /domains Listar domínios
GET /invoices Listar faturas

🌐 Hospedagem

Listar Serviços de Hospedagem

GET /hosting

Retorna todos os serviços de hospedagem do usuário autenticado.

Exemplo de Resposta:
{
    "success": true,
    "data": [
        {
            "id": 1,
            "domain": "meusite.com.br",
            "plan": "Plano Básico",
            "status": "active",
            "created_at": "2024-01-15T10:30:00Z",
            "expires_at": "2025-01-15T10:30:00Z"
        }
    ]
}

Criar Novo Serviço

POST /hosting

Cria um novo serviço de hospedagem.

Parâmetros:
{
    "domain": "novosite.com.br",
    "plan_id": 1,
    "period": 12
}

🔗 Domínios

GET /domains

Lista todos os domínios registrados pelo usuário.

Parâmetros de Query:
  • status - Filtrar por status (active, expired, pending)
  • limit - Limitar número de resultados (padrão: 50)

💰 Faturas

GET /invoices

Retorna todas as faturas do usuário.

Exemplo de Resposta:
{
    "success": true,
    "data": [
        {
            "id": 123,
            "amount": 29.90,
            "status": "paid",
            "description": "Hospedagem - meusite.com.br",
            "due_date": "2024-02-15",
            "paid_at": "2024-02-10T15:30:00Z"
        }
    ]
}

🎫 Suporte

Criar Ticket

POST /support/tickets

Cria um novo ticket de suporte.

Parâmetros:
{
    "subject": "Problema com email",
    "message": "Não consigo receber emails...",
    "priority": "medium",
    "department": "technical"
}

⚠️ Códigos de Erro

Código HTTP Erro Descrição
400 Bad Request Parâmetros inválidos ou ausentes
401 Unauthorized Token de autenticação inválido ou ausente
403 Forbidden Sem permissão para acessar o recurso
404 Not Found Recurso não encontrado
429 Too Many Requests Limite de requisições excedido
500 Internal Server Error Erro interno do servidor

⏱️ Rate Limits

Para garantir a estabilidade do serviço, aplicamos os seguintes limites de taxa:

1000

Requisições por hora

50

Requisições por minuto

Atenção: Ao exceder estes limites, você receberá um erro 429.

Precisa de Ajuda?

Nossa equipe de desenvolvedores está pronta para ajudar você a integrar com nossa API.