Une API (Application Programmation Interface) est une interface de programmation rendue disponible par un système ou logiciel à d’autres systèmes ou logiciels qui peuvent ainsi en exploiter les données fournies. Dans notre cas, la récupération se fera par des appels http. La documentation nécessaire est disponible dans la documentation des APIs.

Par exemple, si je souhaite obtenir les factions existantes et le détail les concernant, je peux aller faire un appel sur la page des APIS liées aux factions, y insérer les paramètres de mon appel puis l’envoyer. Si j’ai fait une erreur sur la clé d’authentification (API key), j’aurai une réponse du type :

Error 401: Unauthorized
{
    "payload": null,
    "id": null,
    "type": null,
    "message": "The provided API key is invalid: this key does not exist.",
    "timestamp": 1683363949.420583,
    "statusCode": 401,
    "statusText": "Unauthorized"
}

Si maintenant j’en fournis une bonne, j’aurai par exemple :  

"pacificator": {
            "faction_id": "pacificator",
            "economic_rating": 4,
            "commercial_rating": 5,
            "defensive_rating": 3,
            "aggressive_rating": 3,
            "autonomous_rating": 4,
            "trade_offer_number_bonus": 3,
            "pillage_in_hiding_arrangement": false,
            "position": 2,
            "specific_elements": [
                "transport_network",
                "general_alert",
                "immortal",
                "cargo_plane"
            ],
            "element_category_order_speeds": {
                "citizen": 1.25,
                "infrastructure": 0.75,
                "research": 1.25
            },
            "citizen_hourly_productions": {
                "coal_miner": 7,
                "silver_miner": 12
            },
            "operation_travel_speeds": {
                "trade": 2
            }
        }

Pour obtenir la clé d’authentification (API key), il te faudra prendre contact avec les administrateurs de l’équipe Arkedya qui pourront ainsi voir avec toi ton besoin et te la fournir. Cela est possible à travers les fonctionnaltiés de support.

L'équipe Arkedya