FiveMX Entwicklerportal

FiveMX veröffentlicht einen schreibgeschützten HTTP API über seinen FiveM Skriptkatalog, eine OpenAPI 3.1 Beschreibung davon und ein Kommandozeilen-Tool, das damit spricht. Alles auf dieser Seite ist öffentlich, benötigt keinen Schlüssel und kann von einer Person, einem Skript oder einem Agenten verwendet werden.

Der FiveMX Katalog API

Ein Namespace, vier GET-Endpunkte, JSON nur. Er gibt die gleichen 1.675 veröffentlichten Produkte frei, die der Shop anbietet, mit Preisen in der Basiswährung des Shops, Lagerbestand, Kategorie und Framework-Tags.

Basis-URL

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

Endpunkte

• GET /catalog — Index mit Anzahlen, Währung und Links zu allem anderen auf dieser Seite
• GET /catalog/categories — alle 46 Kategorien mit Produktanzahlen
• GET /catalog/products — eine Seite mit Produkten, filterbar nach category und framework, bis zu 50 pro Seite
• GET /catalog/products/{slug} — ein einzelnes Produkt anhand seines englischen Slugs

Authentifizierung und Schreibvorgänge

Es gibt keine, und es gibt keine. Jeder Endpunkt ist ein anonymer GET. Nichts hier erstellt eine Bestellung, ändert einen Preis oder berührt ein Konto, daher gibt es keinen Schlüssel zum Leaken und keinen Zustand, den ein Fehler beschädigen könnte.

OpenAPI-Spezifikation

Die vollständige maschinenlesbare Beschreibung, generiert aus demselben Vertrag, gegen den die API implementiert wird, sodass die beiden nicht voneinander abweichen können:

• https://fivemx.com/openapi.json
• https://fivemx.com/.well-known/openapi.json — Byte-identisch, für Clients, die dort zuerst nachsehen
• https://fivemx.com/.well-known/api-catalog — Ein RFC 9727 Linkset, das auf beides verweist

Die Homepage wirbt auch damit mit einem rel="service-desc" Link und https://fivemx.com/llms.txt beschreibt die Seite für Sprachmodelle.

Die FiveMX CLI

Ein offizielles Befehlszeilentool umschließt denselben API. Node 18 oder neuer, keine Laufzeitabhängigkeiten.

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

Exit-Codes trennen einen Anwendungsfehler von einem Ausfall, ohne die Ausgabe zu parsen: 0 ok, 1 Anwendungsfehler ohne gesendete Anfrage, 2 die Anfrage ist fehlgeschlagen, 3 die Ressource existiert nicht.

Fehlerantworten

Fehler sind JSON, niemals eine HTML-Seite, und jede enthält einen Code, eine Nachricht und einen Hinweis, was als Nächstes zu tun ist.

{
  "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."
  }
}

Ein Client, der Accept: application/json, sendet oder sich als bekannter KI-Agent identifiziert, erhält diese Form für jeden fehlenden Pfad auf der Website, nicht nur innerhalb des API-Namespaces. Ein Browser behält die normale Fehlerseite.

Ratenbegrenzungen und Caching

Es gibt keine veröffentlichte Quote. Antworten werden zehn Minuten lang am Ursprung zwischengespeichert, sodass ein Crawl des gesamten Katalogs für beide Seiten kostengünstig ist. Bitte senden Sie einen User-Agent, der Sie identifiziert, und bevorzugen Sie einen paginierten Durchlauf gegenüber vielen einzelnen Produktanfragen.

Was dieses API bewusst nicht tut

• Es stellt keine Warenkörbe, keine Kasse, keine Bestellungen, keine Kunden und keine Downloads bereit. Diese Pfade sind für Crawler geschlossen robots.txt und werden nicht von der Spezifikation beschrieben.
• Es werden keine übersetzten Slugs bedient. Lokale Versionen der Website verwenden übersetzte URLs, und dieses API akzeptiert nur den englischen Slug.
• Es werden keine Preise umgerechnet. Die Werte sind in der Basiswährung angegeben, die von /catalog, gemeldet wird, nicht in der vom Besucher ausgewählten Währung.
• Es gibt keinen MCP-Server, keine Agentenkarte und keinen Webhook-Feed. Wenn einer existiert, wird er hier und im API-Katalog aufgeführt, anstatt durch eine leere Datei angekündigt zu werden.

Fragen zum API gehören auf die FiveMX Kontaktseite.