Saltar al contenido

Orion API — Documento Técnico

Introducción

Orion es la plataforma de CTC para la venta de Tiempo Aire Electrónico (TAE), pago de servicios y pines electrónicos. Esta API permite a tu sistema vender directamente, servidor a servidor, con la misma red de proveedores y el mismo saldo que usas en el panel de Orion.

Esta documentación explica cómo autenticarte, consultar tu saldo y tu catálogo, realizar ventas y verificar su estado.

Requisitos previos

  • Solicitudes HTTP y manejo de JSON.
  • Una organización activa en Orion con el canal API habilitado.
  • Una API Key vigente (ver Autenticación).

URL base

BASE URLhttps://api.faxil.mx/api/v1
VersiónPrefijoAutenticación
v1/api/v1/taeAPI Key (x-api-key)

Endpoints disponibles

Consultas

RecursoMétodoEndpointPermiso de la API Key
SaldoGET/api/v1/tae/balancebalances.read
Catálogo de productosGET/api/v1/tae/productsal menos uno de venta

Transacciones

RecursoMétodoEndpointPermiso de la API Key
Realizar ventaPOST/api/v1/tae/do-transactionsales.tae, sales.services o sales.pins según el producto
Consultar estadoGET/api/v1/tae/check-transaction/:folioninguno adicional (solo tus propias ventas)

Formato de respuesta

Todas las respuestas, exitosas o de error, usan el mismo sobre JSON:

{
"error": false,
"message": "Venta exitosa",
"data": {},
"results": 1
}
CampoTipoDescripción
errorbooleanfalse si la operación fue exitosa, true si falló.
messagestringDescripción legible del resultado o del error.
dataobject | arrayContenido de la respuesta. En errores es [].
resultsnumberNúmero de elementos en data

Consulta Errores y códigos para el detalle de códigos HTTP, límites de peticiones y códigos de transacción.


Empieza aquí