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ón | Prefijo | Autenticación |
|---|---|---|
| v1 | /api/v1/tae | API Key (x-api-key) |
Endpoints disponibles
Consultas
| Recurso | Método | Endpoint | Permiso de la API Key |
|---|---|---|---|
| Saldo | GET | /api/v1/tae/balance | balances.read |
| Catálogo de productos | GET | /api/v1/tae/products | al menos uno de venta |
Transacciones
| Recurso | Método | Endpoint | Permiso de la API Key |
|---|---|---|---|
| Realizar venta | POST | /api/v1/tae/do-transaction | sales.tae, sales.services o sales.pins según el producto |
| Consultar estado | GET | /api/v1/tae/check-transaction/:folio | ninguno 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}| Campo | Tipo | Descripción |
|---|---|---|
error | boolean | false si la operación fue exitosa, true si falló. |
message | string | Descripción legible del resultado o del error. |
data | object | array | Contenido de la respuesta. En errores es []. |
results | number | Nú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í
Primeros pasos De la API Key a tu primera venta en 5 pasos.
Realizar una venta Recargas, servicios y pines con un solo endpoint.