API REST - Documentação para Desenvolvedores | Sistema de Gerenciamento de Documentos Legais

Comece em 3 Passos

Integre em minutos, não em dias

1

Obter API Key

Crie sua conta e obtenha sua chave de API no dashboard.

# No dashboard, vá em Configurações → API
API_KEY = "sk_live_..."
                        

2

Fazer Primeira Requisição

Busque o documento ativo e exiba para o usuário.

import requests

response = requests.get(
    "https://api.legaldocs.com/v1/documents/active/",
    headers={"Authorization": f"Bearer {API_KEY}"}
)
                        

3

Registrar Aceite

Quando o usuário aceitar, registre o aceite via API.

requests.post(
    "https://api.legaldocs.com/v1/acceptances/",
    json={"document_id": 123},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
                        

Exemplos por Linguagem

Código pronto para copiar e usar

Python / Django

import requests
from django.http import JsonResponse

def get_active_document(request):
    # Buscar documento ativo
    response = requests.get(
        "https://api.legaldocs.com/v1/documents/active/?document_type=terms",
        headers={
            "Authorization": f"Bearer {settings.LEGAL_DOCS_API_KEY}",
            "Content-Type": "application/json"
        }
    )
    return JsonResponse(response.json())

def register_acceptance(request, document_id):
    # Registrar aceite do usuário
    response = requests.post(
        "https://api.legaldocs.com/v1/acceptances/",
        json={
            "document_id": document_id,
            "user_id": request.user.id
        },
        headers={
            "Authorization": f"Bearer {settings.LEGAL_DOCS_API_KEY}"
        }
    )
    return JsonResponse(response.json(), status=response.status_code)
                        

Node.js / Express

const axios = require('axios');

// Buscar documento ativo
async function getActiveDocument(documentType = 'terms') {
    const response = await axios.get(
        `https://api.legaldocs.com/v1/documents/active/?document_type=${documentType}`,
        {
            headers: {
                'Authorization': `Bearer ${process.env.LEGAL_DOCS_API_KEY}`
            }
        }
    );
    return response.data;
}

// Registrar aceite
async function registerAcceptance(documentId, userId) {
    const response = await axios.post(
        'https://api.legaldocs.com/v1/acceptances/',
        {
            document_id: documentId,
            user_id: userId
        },
        {
            headers: {
                'Authorization': `Bearer ${process.env.LEGAL_DOCS_API_KEY}`
            }
        }
    );
    return response.data;
}
                        

PHP / Laravel

use Illuminate\Support\Facades\Http;

// Buscar documento ativo
function getActiveDocument($documentType = 'terms') {
    $response = Http::withHeaders([
        'Authorization' => 'Bearer ' . config('services.legal_docs.api_key')
    ])->get("https://api.legaldocs.com/v1/documents/active/", [
        'document_type' => $documentType
    ]);
    
    return $response->json();
}

// Registrar aceite
function registerAcceptance($documentId, $userId) {
    $response = Http::withHeaders([
        'Authorization' => 'Bearer ' . config('services.legal_docs.api_key')
    ])->post('https://api.legaldocs.com/v1/acceptances/', [
        'document_id' => $documentId,
        'user_id' => $userId
    ]);
    
    return $response->json();
}
                        

cURL

# Buscar documento ativo
curl -X GET \
  "https://api.legaldocs.com/v1/documents/active/?document_type=terms" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Registrar aceite
curl -X POST \
  "https://api.legaldocs.com/v1/acceptances/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"document_id": 123, "user_id": 456}'
                        

Endpoints Principais

API completa e RESTful

GET

/api/v1/documents/active/

Retorna o documento ativo atual (opcionalmente filtrado por tipo)

# Exemplo de resposta
{
  "id": 123,
  "document_type": {
    "code": "terms",
    "name": "Termos de Uso"
  },
  "version": "2.1",
  "content": "...",
  "is_active": true
}
                    

POST

/api/v1/acceptances/

Registra o aceite de um documento por um usuário

# Request body
{
  "document_id": 123,
  "user_id": 456
}

# Response
{
  "id": 789,
  "accepted_at": "2024-01-15T10:30:00Z",
  "document": { ... },
  "user": { ... }
}
                    

GET

/api/v1/acceptances/{user_id}/

Lista todos os aceites de um usuário específico

# Response
{
  "count": 2,
  "results": [
    {
      "document": { ... },
      "accepted_at": "2024-01-15T10:30:00Z"
    }
  ]
}
                    

Ver Documentação Completa da API

Por que escolher nossa API?

Rápida e Confiável

99.9% uptime, resposta em menos de 200ms, rate limiting inteligente.

Segura

Autenticação via Bearer Token, HTTPS obrigatório, dados criptografados.

Bem Documentada

Documentação completa, exemplos em múltiplas linguagens, suporte dedicado.

Webhooks

Receba notificações em tempo real quando documentos são aceitos ou atualizados.

RESTful

API REST padrão, fácil de integrar, compatível com qualquer linguagem.

Rate Limiting

Limites generosos (1000 req/min), com possibilidade de aumento para planos enterprise.

Pronto para integrar?

Obtenha sua API Key e comece a integrar em minutos. Suporte técnico incluído.

Obter API Key Grátis Explorar API

✓ Integração em minutos • ✓ Suporte técnico • ✓ Documentação completa

Integre Aceite de Termos em Minutos