Documentación

Introducción

Bienvenido a la documentación de Ordenes.com.ar. Aquí encontrarás toda la información necesaria para integrar nuestro sistema con tus aplicaciones.

Nota: Para acceder a la API necesitas tener un plan activo y generar tus credenciales desde el panel de control.

Características Principales

API REST completa con respuestas JSON
Autenticación OAuth 2.0
Rate limiting configurable por plan
Webhooks para eventos en tiempo real
Documentación interactiva con Swagger

API REST

URL Base

https://api.ordenes.com.ar/v1

Formato de Respuesta

Todas las respuestas son en formato JSON:

{
  "success": true,
  "data": {
    "id": 123,
    "nombre": "Cliente Ejemplo"
  },
  "message": "Operación exitosa"
}

Autenticación

Utilizamos OAuth 2.0 con Bearer Tokens. Incluye el token en el header de cada petición:

Authorization: Bearer tu_token_aqui

Obtener Token

POST /auth/token
Content-Type: application/json

{
  "client_id": "tu_client_id",
  "client_secret": "tu_client_secret",
  "grant_type": "client_credentials"
}

Endpoints Principales

Método	Endpoint	Descripción
GET	`/clientes`	Listar clientes
POST	`/clientes`	Crear cliente
PUT	`/clientes/{id}`	Actualizar cliente
DELETE	`/clientes/{id}`	Eliminar cliente
GET	`/ordenes`	Listar órdenes
POST	`/ordenes`	Crear orden
GET	`/productos`	Listar productos
POST	`/ventas`	Registrar venta

Ejemplos de Uso

Crear un Cliente (cURL)

curl -X POST https://api.ordenes.com.ar/v1/clientes \
  -H "Authorization: Bearer tu_token" \
  -H "Content-Type: application/json" \
  -d '{
    "nombre": "Juan Pérez",
    "email": "juan@example.com",
    "telefono": "1234567890"
  }'

Crear un Cliente (PHP)

Crear un Cliente (JavaScript)

const token = 'tu_token';
const url = 'https://api.ordenes.com.ar/v1/clientes';

const data = {
  nombre: 'Juan Pérez',
  email: 'juan@example.com',
  telefono: '1234567890'
};

fetch(url, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

Webhooks

Los webhooks te permiten recibir notificaciones en tiempo real cuando ocurren eventos en tu cuenta.

Eventos Disponibles

orden.creada - Cuando se crea una orden
orden.actualizada - Cuando cambia el estado de una orden
venta.realizada - Cuando se registra una venta
producto.bajo_stock - Cuando un producto alcanza el stock mínimo

Payload de Ejemplo

{
  "event": "orden.creada",
  "timestamp": "2025-11-18T10:30:00Z",
  "data": {
    "orden_id": 123,
    "cliente_id": 456,
    "estado": "recibido",
    "total": 15000
  }
}

Navegación