Documentacao

Serra Delivery Maps API

Referencia completa de todos os endpoints disponiveis. Base URL: /api/v1

Comecando

Como usar a API

Base URL

https://apiwhstudio.whstudio.site/api/v1

Headers

Content-Type: application/json
Accept: application/json

Exemplo com cURL

curl -X POST https://apiwhstudio.whstudio.site/api/v1/coverage/check \
  -H "Content-Type: application/json" \
  -d '{"lat": -6.1047, "lng": -35.7108}'

Exemplo com JavaScript

const response = await fetch('/api/v1/coverage/check', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    lat: -6.1047,
    lng: -35.7108
  })
});

const data = await response.json();
console.log(data);

Endpoints

GET/api/v1/health

Verificar status da API

Response

{
  "success": true,
  "status": "operational",
  "version": "1.0.0",
  "services": {
    "api": "healthy",
    "database": "healthy"
  }
}

GET/api/v1/cities

Listar cidades atendidas

Query Parameters

active=true&state=RN

Response

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "Serra Caiada",
      "state": "RN",
      "center_lat": -6.1047,
      "center_lng": -35.7108,
      "is_active": true
    }
  ]
}

GET/api/v1/zones

Listar zonas de cobertura

Query Parameters

city_id=uuid&active=true

Response

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "Centro",
      "zone_type": "radius",
      "radius_km": 3,
      "base_delivery_fee": 5.00,
      "fee_per_km": 1.50
    }
  ]
}

Codigos de Status

Respostas HTTP padrao da API

200OKRequisicao bem sucedida

201CreatedRecurso criado com sucesso

400Bad RequestParametros invalidos

404Not FoundRecurso nao encontrado

429Too Many RequestsRate limit excedido

500Internal Server ErrorErro interno do servidor