Documentación para desarrolladores

Espacio de trabajo de la API
https://api.rentron.xyz/v1
Esquema OpenAPI

Consultar pedido

// GET

API de producción

Consultar un pedido

Lee un pedido propio, identifica el momento en que la Energy se puede gastar y determina si la entrega y todo el ciclo del alquiler han terminado.

GET /v1/energy/orders/{id}
En esta página

Usa el UUID que devuelve la creación del pedido o la ruta de su cabecera Location.

Parámetro de ruta

Parámetro Tipo Descripción
id UUID Identificador público del pedido.

Respuesta 200

{"id":"7c0c9a54-517c-4bbb-a946-bf14bf86c113","client_request_id":"order-1042","address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","energy":65000,"duration_minutes":60,"total_trx":"3.200000","status":"delivered","lifecycle_final":false,"delivery_final":true,"created_at":1784376000,"updated_at":1784376073,"energy_usable":true,"rental_expires_at":1784379612}

Un campo sin valor se omite de la respuesta en vez de enviarse como null: un pedido que todavía no ha llegado a ninguna dirección no trae la clave rental_expires_at, y uno correcto no trae la clave failure. Lee una clave ausente como null y no exijas que esté presente.

Campo Tipo Descripción
status cadena created, executing, available, delivered, rental_finished, failed o rental_interrupted.
energy_usable booleano La Energy está en la dirección y se puede gastar. Es true en available y en delivered mientras rental_expires_at no haya llegado, y false a partir de ese momento, aunque el estado siga mostrando delivered un rato más: el final del alquiler se confirma con datos de la red ya finalizados.
rental_expires_at entero, ausente si no tiene valor Segundos Unix en los que termina la ventana de alquiler pagada. Falta hasta que la Energy llega a la dirección, y vuelve a faltar en failed: ahí el importe retenido se libera por completo y con él se anula la ventana. En rental_interrupted se conserva la ventana en la que ese alquiler quedó cortado.
lifecycle_final booleano Todo el alquiler ha terminado y no habrá más transiciones.
delivery_final booleano El intento de entrega ha terminado. Sigue en false mientras el pedido está en available, porque ahí la entrega todavía no se ha verificado de forma independiente. true no significa éxito por sí solo: mira failure.
failure objeto, ausente si no tiene valor Aparece en failed con code: energy_delivery_failed y en rental_interrupted con code: energy_delivery_interrupted. En ambos casos lleva ese code estable y un message que se puede mostrar sin riesgo.
created_at, updated_at entero Segundos Unix.

Cuándo enviar tu transacción

Decide con energy_usable, no con delivered.

{"status":"available","lifecycle_final":false,"delivery_final":false,"energy_usable":true,"rental_expires_at":1784379612}

available significa que la Energy ya está delegada a la dirección y se puede gastar, y que la ventana que has pagado corre hasta rental_expires_at. Alrededor de un minuto después, delivered lo sustituye, cuando una verificación independiente demuestra la entrega; rental_expires_at no se mueve por ello. Esperar a delivered solo gasta alquiler que ya has pagado.

Cuándo dejar de consultar

Para solo cuando las dos banderas finales sean true. Un ciclo completo correcto termina en rental_finished. failed y rental_interrupted incluyen failure.

No encontrado

Un ID inexistente y uno de otra cuenta devuelven la misma respuesta a propósito:

{"type":"https://rentron.xyz/docs/errors/codes#energy_order_not_found","title":"Not Found","status":404,"detail":"Order was not found.","code":"energy_order_not_found"}