FiveMX Portail développeur

FiveMX publie un HTTP API en lecture seule sur son catalogue de scripts FiveM, une description OpenAPI 3.1 de celui-ci, et un outil en ligne de commande qui interagit avec. Tout sur cette page est public, ne nécessite aucune clé et peut être utilisé par une personne, un script ou un agent.

Le catalogue FiveMX API

Un espace de noms, quatre points d'accès GET, JSON uniquement. Il expose les mêmes 1.675 produits publiés que la boutique, avec les prix dans la devise de base du magasin, le stock, la catégorie et les tags du framework.

URL de base

https://fivemx.com/wp-json/fivemx/v1

Points d'accès

• GET /catalog — index avec les décomptes, la devise et les liens vers tout le reste sur cette page
• GET /catalog/categories — toutes les 46 catégories avec le nombre de produits
• GET /catalog/products — une page de produits, filtrable par category et framework, jusqu'à 50 par page
• GET /catalog/products/{slug} — un produit unique par son slug anglais

Authentification et écritures

Il n'y en a pas, et il n'y en a pas. Chaque point de terminaison est un GET anonyme. Rien ici ne crée une commande, ne modifie un prix ou ne touche un compte, il n'y a donc pas de clé à divulguer et pas d'état à endommager par une erreur.

Spécification OpenAPI

La description complète lisible par machine, générée à partir du même contrat que celui contre lequel le API est implémenté, de sorte que les deux ne peuvent pas dériver :

• https://fivemx.com/openapi.json
• https://fivemx.com/.well-known/openapi.json — octet par octet identique, pour les clients qui regardent d'abord là-bas
• https://fivemx.com/.well-known/api-catalog — un jeu de liens RFC 9727 pointant vers les deux

La page d'accueil le mentionne également avec un rel="service-desc" lien, et https://fivemx.com/llms.txt décrit le site pour les modèles linguistiques.

Le FiveMX CLI

Un outil en ligne de commande officiel encapsule le même API. Node 18 ou plus récent, zéro dépendance d'exécution.

npm install -g @fivemx/cli
fivemx catalog
fivemx products --framework qbcore --per-page 5
fivemx product audio-speaker-script --json

Les codes de sortie séparent une erreur d'utilisation d'une panne sans analyser aucune sortie : 0 ok, 1 erreur d'utilisation sans requête envoyée, 2 la requête a échoué, 3 la ressource n'existe pas.

Réponses d'erreur

Les erreurs sont des JSON, jamais une page HTML, et chacune contient un code, un message et une indication sur la marche à suivre.

{
  "code": "fivemx_product_not_found",
  "message": "No published product has that slug.",
  "data": {
    "status": 404,
    "hint": "Slugs come from /wp-json/fivemx/v1/catalog/products."
  }
}

Un client qui envoie Accept: application/json, ou qui s'identifie comme un agent IA connu, reçoit cette forme pour tout chemin manquant sur le site, pas seulement à l'intérieur de l'espace de noms API. Un navigateur conserve la page d'erreur normale.

Limites de débit et mise en cache

Il n'y a pas de quota publié. Les réponses sont mises en cache pendant dix minutes à l'origine, de sorte qu'un parcours de l'ensemble du catalogue est peu coûteux pour les deux parties. Veuillez envoyer un agent utilisateur qui vous identifie, et privilégiez un passage paginé plutôt que de nombreuses requêtes de produits uniques.

Ce que ce API ne fait pas délibérément

• Il n'expose pas les paniers, la validation de commande, les commandes, les clients ou les téléchargements. Ces chemins sont fermés aux robots d'exploration robots.txt et ne sont pas décrits par la spécification.
• Il ne sert pas de slugs traduits. Les versions locales du site utilisent des URL traduites, et ce API n'accepte que le slug anglais.
• Il ne convertit pas les prix. Les valeurs sont dans la devise de base rapportée par /catalog, pas dans la devise sélectionnée par un visiteur.
• Il n'y a pas de serveur MCP, pas de carte d'agent et pas de flux webhook. Lorsqu'il en existe un, il sera listé ici et dans le catalogue API plutôt que d'être annoncé par un fichier vide.

Les questions concernant le API doivent être posées sur le FiveMX page de contact.