Documentación de la API
Referencia completa de la API REST para integrar grids de OpenSimulator con ZoneCoin. Autentique, consulte saldos, transfiera fondos y gestione instancias de forma programática.
🌐 URL base
https://zonecoin.zonenations.com/api/index.php/v1/zonecoin/dll
Todas las solicitudes API deben enviarse a la URL base siguiente. Agregue la ruta del endpoint para construir la URL completa.
🔒 Autenticación
La mayoría de los endpoints requieren autenticación mediante API Key + Secreto Compartido. Incluya estas cabeceras en cada solicitud autenticada.
⚡ Endpoints
/ping
Health Check
🔓 Público
Comprobar si la API está activa y responde. No requiere autenticación.
Ejemplo de respuesta
{
"success": true,
"status": "alive",
"service": "ZoneCoin DLL Helper",
"currency": "ZoneCoin",
"symbol": "ZC",
"timestamp": "2026-02-17 12:00:00"
}
/balance
Query Balance
🔒 Autenticación requerida
Consultar el saldo de ZoneCoin de un avatar específico.
Parámetros
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
avatar_uuid |
string | ✓ | UUID del avatar en OpenSimulator |
Ejemplo de respuesta
{
"success": true,
"balance": 1500,
"currency": "ZC"
}
/transfer
Transfer Funds
🔒 Autenticación requerida
Transferir ZoneCoin entre dos avatares. Las comisiones se aplican automáticamente.
Parámetros
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
sender_uuid |
string | ✓ | UUID del avatar remitente |
receiver_uuid |
string | ✓ | UUID del avatar destinatario |
amount |
float | ✓ | Cantidad a transferir/comprar/vender |
description |
string | — | Descripción de transacción opcional |
Ejemplo de respuesta
{
"success": true,
"tx_hash": "abc123...",
"net_amount": 99.5,
"fee": 0.5
}
/buy
Buy Currency
🔒 Autenticación requerida
Comprar ZoneCoin para una cuenta de avatar.
Parámetros
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
avatar_uuid |
string | ✓ | UUID del avatar en OpenSimulator |
amount |
float | ✓ | Cantidad de ZoneCoin a comprar |
Ejemplo de respuesta
{
"success": true,
"credited": 1000,
"cost_usd": 10
}
/sell
Sell Currency
🔒 Autenticación requerida
Vender ZoneCoin de una cuenta de avatar a la plataforma.
Parámetros
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
avatar_uuid |
string | ✓ | UUID del avatar en OpenSimulator |
amount |
float | ✓ | Cantidad de ZoneCoin a vender |
Ejemplo de respuesta
{
"success": true,
"deducted": 500,
"payout_usd": 5
}
/discover
Discover Instances
🔒 Autenticación requerida
Listar todas las instancias de grid activas registradas en la plataforma.
Ejemplo de respuesta
{
"success": true,
"instances": [
{
"uuid": "...",
"name": "MyGrid",
"status": "active",
"online_users": 12
}
],
"count": 1
}
/register
Register Instance
🔒 Autenticación requerida
Registrar una nueva instancia OpenSimulator en la plataforma.
Parámetros
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
name |
string | ✓ | Nombre de la instancia OpenSimulator |
base_url |
string | ✓ | URL base de la instancia OpenSimulator |
Ejemplo de respuesta
null
/currencyServer
Currency Server (Legacy Migration)
🔒 Autenticación requerida
Endpoint de economía nativa ZoneCoin. Compatible con las acciones balance, transfer, buy, sell, pay_object y land_buy a través del Módulo OpenSim ZoneCoin.
Parámetros
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
method |
string | ✓ | Nombre de la acción (balance, transfer, buy, sell, etc.) |
agentId |
string | — | ID de agente (mapeado a avatar_uuid) |
amount |
float | — | Cantidad a transferir/comprar/vender |
Ejemplo de respuesta
{
"success": true,
"balance": 1500
}
/landTool
Land Tool
🔒 Autenticación requerida
Procesar transacciones de compra de terreno desde OpenSimulator.
Parámetros
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
avatar_uuid |
string | ✓ | UUID del avatar en OpenSimulator |
amount |
float | ✓ | Cantidad a transferir/comprar/vender |
region |
string | — | Nombre de la región para operaciones de terreno |
Ejemplo de respuesta
{
"success": true,
"tx_hash": "land_abc123..."
}
⏳ Límites de frecuencia
| Endpoints predeterminados | 60 req/min |
| Consultas de saldo | 120 req/min |
| Transferencias | 30 req/min |
| Comprobación de estado (ping) | Ilimitado |
⚠ Códigos de error
| Code | Descripción |
|---|---|
| 200 | Éxito — solicitud completada |
| 400 | Solicitud incorrecta — parámetros ausentes o no válidos |
| 401 | No autorizado — clave API o secreto no válidos |
| 429 | Demasiadas solicitudes — límite de frecuencia superado |
| 500 | Error interno del servidor |
| 503 | Servicio no disponible — integración API o DLL desactivada |