Saltar al contenido
Orion API

Primeros pasos

Flujo de integración

  1. Obtén tu API Key. El administrador de tu organización la genera en el panel de Orion, o la solicitas al equipo de soporte de CTC. Guárdala en un gestor de secretos: solo se muestra una vez. Ver Autenticación.

  2. Verifica tu saldo. Llama a GET /tae/balance. Orion maneja dos bolsas: TAE y SERVICIOS.

  3. Descarga tu catálogo. Llama a GET /tae/products y guarda el id de cada producto: es el carrier_id que envías al vender.

  4. Realiza una venta. Envía POST /tae/do-transaction con un folio único generado por tu sistema.

  5. Concilia. Si la venta no devolvió un resultado definitivo, consulta GET /tae/check-transaction/:folio antes de reintentar.

sequenceDiagram participant C as Tu sistema participant O as Orion API C->>O: GET /tae/balance (x-api-key) O-->>C: Saldo por bolsa C->>O: GET /tae/products O-->>C: Catálogo (carrier_id) C->>O: POST /tae/do-transaction (folio único) alt Resultado definitivo O-->>C: 200 Venta exitosa / 400 rechazada else Timeout o 502 C->>O: GET /tae/check-transaction/{folio} O-->>C: Estado real de la venta end

Verificar antes de salir a producción

  • La API Key se guarda en un gestor de secretos, nunca en el código, el frontend o los logs.
  • El timeout HTTP de tu cliente es de al menos 180 segundos en do-transaction.
  • Cada venta usa un folio único y lo guardas antes de enviar la venta.
  • Ante timeout, o codigo 500, tu sistema debe consultar el folio en vez de reintentar.
  • Respetar los encabezados rate-limit.
  • Validar el saldo de la bolsa correcta antes de vender.

Colección para Hoppscotch

¿Quieres probar la API sin escribir código? Descarga la colección y los entornos de Hoppscotch desde Descargas.