📖 Grid Owner Resources

Документация API

Полный справочник REST API для интеграции гридов OpenSimulator с ZoneCoin. Аутентификация, запрос баланса, перевод средств и управление экземплярами программно.

🌐 Базовый URL

https://zonecoin.zonenations.com/api/index.php/v1/zonecoin/dll

Все API-запросы должны отправляться на базовый URL ниже. Добавьте путь эндпоинта для построения полного URL.

🔒 Аутентификация

Большинство эндпоинтов требуют аутентификации по API-ключу + общему секрету. Включайте эти заголовки в каждый аутентифицированный запрос.

# Заголовки запроса
X-ZoneCoin-ApiKey: <your_api_key>
X-ZoneCoin-Secret: <your_shared_secret>
# Альтернатива: подпись HMAC
X-ZoneCoin-Signature: HMAC-SHA256(body, shared_secret)

⚡ Эндпоинты

GET /ping Health Check 🔓 Публичный

Проверить, работает ли API и отвечает. Аутентификация не требуется.

Пример ответа 

{
    "success": true,
    "status": "alive",
    "service": "ZoneCoin DLL Helper",
    "currency": "ZoneCoin",
    "symbol": "ZC",
    "timestamp": "2026-02-17 12:00:00"
}
GET /balance Query Balance 🔒 Требуется аутентификация

Запрос баланса ZoneCoin для определённого аватара.

Параметры

Имя Тип Обязательный Описание
avatar_uuid string ✓ UUID аватара в OpenSimulator

Пример ответа 

{
    "success": true,
    "balance": 1500,
    "currency": "ZC"
}
POST /transfer Transfer Funds 🔒 Требуется аутентификация

Перевести ZoneCoin между двумя аватарами. Комиссии применяются автоматически.

Параметры

Имя Тип Обязательный Описание
sender_uuid string ✓ UUID аватара-отправителя
receiver_uuid string ✓ UUID аватара-получателя
amount float ✓ Сумма для перевода/покупки/продажи
description string — Необязательное описание транзакции

Пример ответа 

{
    "success": true,
    "tx_hash": "abc123...",
    "net_amount": 99.5,
    "fee": 0.5
}
POST /buy Buy Currency 🔒 Требуется аутентификация

Купить ZoneCoin для аккаунта аватара.

Параметры

Имя Тип Обязательный Описание
avatar_uuid string ✓ UUID аватара в OpenSimulator
amount float ✓ Сумма ZoneCoin для покупки

Пример ответа 

{
    "success": true,
    "credited": 1000,
    "cost_usd": 10
}
POST /sell Sell Currency 🔒 Требуется аутентификация

Продать ZoneCoin с аккаунта аватара на платформу.

Параметры

Имя Тип Обязательный Описание
avatar_uuid string ✓ UUID аватара в OpenSimulator
amount float ✓ Сумма ZoneCoin для продажи

Пример ответа 

{
    "success": true,
    "deducted": 500,
    "payout_usd": 5
}
GET /discover Discover Instances 🔒 Требуется аутентификация

Показать все активные экземпляры гридов, зарегистрированные на платформе.

Пример ответа 

{
    "success": true,
    "instances": [
        {
            "uuid": "...",
            "name": "MyGrid",
            "status": "active",
            "online_users": 12
        }
    ],
    "count": 1
}
POST /register Register Instance 🔒 Требуется аутентификация

Регистрация нового экземпляра OpenSimulator на платформе.

Параметры

Имя Тип Обязательный Описание
name string ✓ Имя экземпляра OpenSimulator
base_url string ✓ Базовый URL экземпляра OpenSimulator

Пример ответа 

null
POST /currencyServer Currency Server (Legacy Migration) 🔒 Требуется аутентификация

Нативный экономический эндпоинт ZoneCoin. Поддерживает действия balance, transfer, buy, sell, pay_object и land_buy через модуль ZoneCoin OpenSim.

Параметры

Имя Тип Обязательный Описание
method string ✓ Имя действия (balance, transfer, buy, sell и т.д.)
agentId string — ID агента (сопоставляется с avatar_uuid)
amount float — Сумма для перевода/покупки/продажи

Пример ответа 

{
    "success": true,
    "balance": 1500
}
POST /landTool Land Tool 🔒 Требуется аутентификация

Обработать транзакции покупки земли из OpenSimulator.

Параметры

Имя Тип Обязательный Описание
avatar_uuid string ✓ UUID аватара в OpenSimulator
amount float ✓ Сумма для перевода/покупки/продажи
region string — Имя региона для операций с землёй

Пример ответа 

{
    "success": true,
    "tx_hash": "land_abc123..."
}

⏳ Ограничения частоты

Стандартные эндпоинты60 req/min
Запросы баланса120 req/min
Переводы30 req/min
Проверка состояния (ping)Без ограничений

⚠ Коды ошибок

Code Описание
200Успех — запрос выполнен
400Неверный запрос — отсутствуют или недопустимые параметры
401Не авторизован — недопустимый API-ключ или секрет
429Слишком много запросов — превышен лимит частоты
500Внутренняя ошибка сервера
503Сервис недоступен — API или интеграция DLL отключена

🚀 Быстрые ссылки

🏠 Панель управления владельца сетки ⚙ Модуль DLL 🌐 Зарегистрироваться как владелец сетки