# Referência API

Documentação completa da API REST do DeployAlly.

# Base URL

# Autenticação

A API usa autenticação via API Key no header:

Authorization: Bearer da_xxx

Veja Autenticação para detalhes sobre como obter e gerenciar API Keys.

# Formato

• Request: JSON (Content-Type: application/json)
• Response: JSON
• Encoding: UTF-8

# Endpoints

# Templates

# Definitions

# Instances

# Servers

# Deployments

# Respostas

# Sucesso

{
  "success": true,
  "data": { ... }
}

# Lista com Paginação

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 100,
    "total_pages": 5
  }
}

# Erro

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Campo 'name' é obrigatório",
    "details": { ... }
  }
}

# Códigos de Erro

# Rate Limits

Headers de resposta:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1699900000

# Exemplos

# Listar Templates

curl -X GET "https://sys.deployally.com/api/v1/templates" \
  -H "Authorization: Bearer da_xxx"

# Criar Definition

curl -X POST "https://sys.deployally.com/api/v1/definitions" \
  -H "Authorization: Bearer da_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "mysql-8.4",
    "name": "mysql_meu_banco",
    "params": {
      "database_name": "meu_banco",
      "user_name": "meu_usuario",
      "user_password": "senha_segura"
    },
    "profile": "development"
  }'

# Deploy

curl -X POST "https://sys.deployally.com/api/v1/deployments" \
  -H "Authorization: Bearer da_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "definition_id": "def_abc123",
    "server_id": "srv_xyz789"
  }'

# SDKs

SDKs oficiais em desenvolvimento:

• Python (em breve)
• Node.js (em breve)
• Go (em breve)

# Próximos Passos

• Autenticação - Gerenciamento de API Keys
• Endpoints - Documentação detalhada
• Integração - Guia de integração