Code Contract API
Integra la gestión de contratos en tu aplicación con nuestra API RESTful potente y fácil de usar
Comenzar en 5 minutos
Sigue estos simples pasos para comenzar a usar la API de Code Contract
Regístrate
Crea tu cuenta y obtén tus credenciales de API
Autentícate
Usa OAuth 2.0 para obtener tu token de acceso
Haz tu primera llamada
Envía una petición GET para obtener tus contratos
Autenticación
La API de Code Contract usa OAuth 2.0 para autenticación. Necesitarás obtener un token de acceso antes de hacer llamadas a la API.
Obtener Token de Acceso
curl -X POST https://api.codecontract.com/oauth/token \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "tu_client_id",
"client_secret": "tu_client_secret"
}'
Usar el Token
Incluye el token en el header Authorization de todas tus peticiones:
curl -H "Authorization: Bearer tu_access_token" \
https://api.codecontract.com/contracts
Contratos
Gestiona contratos mediante operaciones CRUD completas.
Listar Contratos
| Parámetro | Tipo | Descripción |
|---|---|---|
page |
integer | Número de página (por defecto: 1) |
limit |
integer | Elementos por página (por defecto: 20, máximo: 100) |
status |
string | Filtrar por estado: draft, pending, signed, expired |
{
"data": [
{
"id": "contract_123",
"title": "Contrato de Servicios",
"status": "signed",
"created_at": "2025-01-15T10:30:00Z",
"signed_at": "2025-01-16T14:20:00Z",
"parties": [
{
"name": "Juan Pérez",
"email": "juan@empresa.com",
"role": "signer"
}
]
}
],
"pagination": {
"current_page": 1,
"total_pages": 5,
"total_items": 87
}
}
Crear Contrato
{
"title": "Nuevo Contrato",
"document_url": "https://mi-empresa.com/contrato.pdf",
"parties": [
{
"name": "María García",
"email": "maria@cliente.com",
"role": "signer"
}
],
"metadata": {
"department": "Ventas",
"project": "Proyecto ABC"
}
}
Firmas
Gestiona el proceso de firma digital de contratos.
Solicitar Firma
{
"signer_email": "firmante@empresa.com",
"signature_type": "electronic",
"reminder_frequency": "daily",
"expiration_days": 30,
"custom_message": "Por favor firma este contrato"
}
Estado de Firma
Webhooks
Recibe notificaciones en tiempo real sobre eventos importantes.
Eventos Disponibles
contract.created- Contrato creadocontract.signed- Contrato firmadocontract.expired- Contrato expiradosignature.completed- Firma completadasignature.declined- Firma rechazada
Configurar Webhook
{
"url": "https://tu-app.com/webhooks/codecontract",
"events": ["contract.signed", "signature.completed"],
"secret": "tu_webhook_secret"
}
Códigos de Error
La API utiliza códigos de estado HTTP estándar para indicar el éxito o fallo de las peticiones.
| Código | Descripción |
|---|---|
200 |
OK - Petición exitosa |
400 |
Bad Request - Parámetros inválidos |
401 |
Unauthorized - Token de autenticación inválido |
404 |
Not Found - Recurso no encontrado |
429 |
Too Many Requests - Límite de velocidad excedido |
500 |
Internal Server Error - Error del servidor |
Límites de Velocidad
Para garantizar la calidad del servicio, implementamos límites de velocidad en la API.
- Plan Starter: 100 peticiones por minuto
- Plan Professional: 500 peticiones por minuto
- Plan Enterprise: 2000 peticiones por minuto
Los headers de respuesta incluyen información sobre tu límite actual:
X-RateLimit-Limit: 500
X-RateLimit-Remaining: 487
X-RateLimit-Reset: 1642608000
¿Listo para empezar?
Obtén acceso completo a la API y comienza a integrar Code Contract hoy mismo