API de Integración

Nuestra API REST te permite conectar de forma segura el CRM Dental con sistemas de facturación externa (Alegra, Factura PA, QuickBooks, etc). Extrae datos de pacientes, servicios realizados y pagos registrados en tiempo real para emitir tus facturas fiscales automáticamente.

Nota: La API responde exclusivamente en formato JSON y utiliza códigos de estado HTTP estándar.

Autenticación

La API utiliza llaves de acceso (API Keys) para autenticar las peticiones. Puedes generar o revocar tu llave desde el panel de Ajustes > Facturación en tu cuenta de administrador.

Debes incluir tu llave en todas las peticiones utilizando el header X-API-Key.

Dato Importante: Toda la plataforma utiliza un único dominio principal (ej. api.oralcrm.com). No necesitas configurar un dominio propio para tu clínica. Nuestro servidor sabe exactamente a qué clínica pertenecen los datos única y exclusivamente gracias a tu X-API-Key. ¡Mantenla en secreto!
Ejemplo de petición
curl https://api.oralcrm.com/api/integration/invoices \-H "X-API-Key: cl_live_xxxxxxxxxxxxxxxxx"

Listar FacturasGET

Devuelve una lista de cuentas o facturas registradas en la clínica. Útil para que los sistemas externos busquen periódicamente qué nuevas cuentas necesitan ser procesadas.

Endpoint

GET /api/integration/invoices

Parámetros Query

Parámetro
Descripción
status
Opcional. Filtra por estado: PENDING, PARTIAL, PAID.

Respuesta (JSON)

{
  "success": true,
  "count": 1,
  "data": [
    {
      "id": "inv_123abc",
      "status": "PAID",
      "createdAt": "2026-05-14T10:00:00Z",
      "customer": {
        "name": "Juan Pérez",
        "taxId": "8-123-456",
        "dv": "12",
        "email": "juan@example.com",
        "address": "Calle 50, Panamá",
        "type": "NATURAL"
      },
      "financials": {
        "totalAmount": 150.00,
        "paidAmount": 150.00,
        "currency": "USD"
      },
      "payments": [
        {
          "paymentId": "pay_999xyz",
          "amount": 150.00,
          "method": "YAPPY",
          "date": "2026-05-14T10:05:00Z"
        }
      ]
    }
  ]
}

Detalle de FacturaGET

Recupera el detalle específico de una factura, incluyendo la lista de ítems o tratamientos realizados para poder emitir el documento fiscal detallado.

Endpoint

GET /api/integration/invoices/:id

Respuesta (JSON)

{
  "success": true,
  "data": {
    "id": "inv_123abc",
    "status": "PAID",
    "customer": { ... },
    "financials": { ... },
    "items": [
      {
        "description": "Limpieza Dental Ultrasónica",
        "price": 80.00,
        "quantity": 1
      },
      {
        "description": "Radiografía Panorámica",
        "price": 70.00,
        "quantity": 1
      }
    ]
  }
}