📖 Grid Owner Resources

Documentation API

Référence complète de l'API REST pour l'intégration des grilles OpenSimulator avec ZoneCoin. Authentifiez-vous, interrogez les soldes, transférez des fonds et gérez les instances de manière programmatique.

🌐 URL de base

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

Toutes les requêtes API doivent être envoyées à l'URL de base ci-dessous. Ajoutez le chemin du point de terminaison pour construire l'URL complète.

🔒 Authentification

La plupart des points de terminaison nécessitent une authentification par clé API + secret partagé. Incluez ces en-têtes dans chaque requête authentifiée.

# En-têtes de requête
X-ZoneCoin-ApiKey: <your_api_key>
X-ZoneCoin-Secret: <your_shared_secret>
# Alternative : signature HMAC
X-ZoneCoin-Signature: HMAC-SHA256(body, shared_secret)

⚡ Endpoints

GET /ping Health Check 🔓 Public

Vérifier si l'API est active et répond. Aucune authentification requise.

Exemple de réponse

{
    "success": true,
    "status": "alive",
    "service": "ZoneCoin DLL Helper",
    "currency": "ZoneCoin",
    "symbol": "ZC",
    "timestamp": "2026-02-17 12:00:00"
}
GET /balance Query Balance 🔒 Authentification requise

Interrogez le solde ZoneCoin d'un avatar spécifique.

Paramètres

Nom Type Obligatoire Description
avatar_uuid string UUID de l'avatar dans OpenSimulator

Exemple de réponse

{
    "success": true,
    "balance": 1500,
    "currency": "ZC"
}
POST /transfer Transfer Funds 🔒 Authentification requise

Transférer des ZoneCoin entre deux avatars. Les frais sont appliqués automatiquement.

Paramètres

Nom Type Obligatoire Description
sender_uuid string UUID de l'avatar expéditeur
receiver_uuid string UUID de l'avatar destinataire
amount float Montant à transférer/acheter/vendre
description string Description optionnelle de la transaction

Exemple de réponse

{
    "success": true,
    "tx_hash": "abc123...",
    "net_amount": 99.5,
    "fee": 0.5
}
POST /buy Buy Currency 🔒 Authentification requise

Acheter des ZoneCoin pour un compte avatar.

Paramètres

Nom Type Obligatoire Description
avatar_uuid string UUID de l'avatar dans OpenSimulator
amount float Montant de ZoneCoin à acheter

Exemple de réponse

{
    "success": true,
    "credited": 1000,
    "cost_usd": 10
}
POST /sell Sell Currency 🔒 Authentification requise

Vendre des ZoneCoin d'un compte avatar vers la plateforme.

Paramètres

Nom Type Obligatoire Description
avatar_uuid string UUID de l'avatar dans OpenSimulator
amount float Montant de ZoneCoin à vendre

Exemple de réponse

{
    "success": true,
    "deducted": 500,
    "payout_usd": 5
}
GET /discover Discover Instances 🔒 Authentification requise

Lister toutes les instances de grille actives enregistrées sur la plateforme.

Exemple de réponse

{
    "success": true,
    "instances": [
        {
            "uuid": "...",
            "name": "MyGrid",
            "status": "active",
            "online_users": 12
        }
    ],
    "count": 1
}
POST /register Register Instance 🔒 Authentification requise

Enregistrer une nouvelle instance OpenSimulator sur la plateforme.

Paramètres

Nom Type Obligatoire Description
name string Nom de l'instance OpenSimulator
base_url string URL de base de l'instance OpenSimulator

Exemple de réponse

null
POST /currencyServer Currency Server (Legacy Migration) 🔒 Authentification requise

Endpoint d'économie native ZoneCoin. Prend en charge les actions balance, transfer, buy, sell, pay_object et land_buy via le Module OpenSim ZoneCoin.

Paramètres

Nom Type Obligatoire Description
method string Nom de l'action (balance, transfer, buy, sell, etc.)
agentId string Identifiant de l'agent (mappé sur avatar_uuid)
amount float Montant à transférer/acheter/vendre

Exemple de réponse

{
    "success": true,
    "balance": 1500
}
POST /landTool Land Tool 🔒 Authentification requise

Traiter les transactions d'achat de terrain depuis OpenSimulator.

Paramètres

Nom Type Obligatoire Description
avatar_uuid string UUID de l'avatar dans OpenSimulator
amount float Montant à transférer/acheter/vendre
region string Nom de la région pour les opérations foncières

Exemple de réponse

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

⏳ Limites de débit

Endpoints standard60 req/min
Requêtes de solde120 req/min
Transferts30 req/min
Vérification de santé (ping)Illimité

⚠ Codes d'erreur

Code Description
200Succès — requête terminée
400Requête incorrecte — paramètres manquants ou invalides
401Non autorisé — clé API ou secret invalide
429Trop de requêtes — limite de débit dépassée
500Erreur interne du serveur
503Service indisponible — API ou intégration DLL désactivée