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.

Comeí§ar Agora Ver Endpoints
GET /api/v1/hosting
{
  "success": true,
  "data": [
    {
      "id": 1,
      "domain": "example.com.br",
      "status": "active",
      "plan": "Profissional"
    }
  ]
}
Navegação

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.

Entrar em Contato Central de Ajuda