Saltar al contenido principal

Partner Portal APIs

Portal endpoints for authenticated partner users.

Base URL​

https://service-gateway.loscenotes.com/api/partner-portal

Authentication​

Authorization: Bearer <jwt>

Endpoint groups​

Dashboard​

Métricas

GET /api/partner-portal/metrics devuelve el tráfico de tu API: apiCalls, responseTime, errorRate, topEndpoints, statusCodes. Si todavía no hay tráfico, la serie queda vacía. Los indicadores de negocio salen de GET /api/partner-portal/dashboard.

  • GET /api/partner-portal/dashboard
  • GET /api/partner-portal/metrics
  • GET /api/partner-portal/activity-feed

API key management​

  • GET /api/partner-portal/api-keys — returns masked key + keyPrefix + lastUsedAt (no full secret)
  • POST /api/partner-portal/api-keys — once-reveal full key on create
  • PUT /api/partner-portal/api-keys/:keyId
  • DELETE /api/partner-portal/api-keys/:keyId
  • POST /api/partner-portal/api-keys/:keyId/rotate — once-reveal on rotate

Webhooks​

Solo HTTPS público

Crear, actualizar y probar rechazan URLs privadas y de metadata. La entrega acepta solo HTTPS público y no sigue redirecciones.

  • GET /api/partner-portal/webhooks
  • POST /api/partner-portal/webhooks
  • PUT /api/partner-portal/webhooks/:webhookId
  • DELETE /api/partner-portal/webhooks/:webhookId
  • POST /api/partner-portal/webhooks/:webhookId/test
  • GET /api/partner-portal/webhooks/:webhookId/logs

Onboarding​

  • POST /api/partner-portal/onboarding/start
  • GET /api/partner-portal/onboarding/status
  • POST /api/partner-portal/onboarding/complete-step/:step

Portal sandbox​

  • GET /api/partner-portal/sandbox/status
  • POST /api/partner-portal/sandbox/reset
  • POST /api/partner-portal/sandbox/generate-data

Disponible cuando el almacenamiento sandbox está provisionado: generate, reset y status ejecutan operaciones reales. Si no está provisionado, esas rutas del portal igual responden HTTP 200 con un cuerpo que explica la indisponibilidad. Las claves sk_test_ emitidas son solo para sandbox y no pueden llamar /api/partner/*.

Billing and usage​

Facturación parcial

Los conteos de llamadas pueden ser reales. Ancho de banda, uso de webhooks, catálogo de planes y liquidaciones mostradas como facturas no están completos. La pantalla de facturación del portal lista uso, facturas y plan, y no es un producto comercial completo.

  • GET /api/partner-portal/billing/usage
  • GET /api/partner-portal/billing/invoices
  • GET /api/partner-portal/billing/plan

Soporte​

JWT de partner. Crear exige el permiso partner.manage_settings. Listar, ver el detalle y responder exigen partner.view_settings. El triaje de personal está en APIs de admin.

  • POST /api/partner-portal/support/ticket — cuerpo subject (5–200), description (20–2000), category (1–50). priority opcional: low, medium, high, urgent.
  • GET /api/partner-portal/support/tickets — query page (default 1) y limit (default 20)
  • GET /api/partner-portal/support/tickets/:ticketId — ticket y respuestas. :ticketId es un UUID.
  • POST /api/partner-portal/support/tickets/:ticketId/replies — cuerpo { "message": "..." } (1–5000 caracteres)
  • GET /api/partner-portal/quickstart

Notes​

  • these endpoints are operational/portal-focused, not public partner API key endpoints
  • data isolation is enforced through the authenticated partner context
  • for organization-level config, users, reports, reservations and sandbox tooling, see Management features