FiveMX Developer Portal

FiveMX publiceert een alleen-lezen HTTP API over zijn FiveM scriptcatalogus, een OpenAPI 3.1-beschrijving ervan, en een command-line tool die ermee communiceert. Alles op deze pagina is openbaar, heeft geen sleutel nodig en kan worden gebruikt door een persoon, een script of een agent.

De FiveMX catalogus API

Eén namespace, vier GET-eindpunten, JSON alleen. Het exposeert dezelfde 1.675 gepubliceerde producten als de winkel, met prijzen in de basisvaluta van de winkel, voorraad, categorie en framework-tags.

Basis URL

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

Eindpunten

• GET /catalog — index met tellingen, valuta en links naar al het andere op deze pagina
• GET /catalog/categories — alle 46 categorieën met productaantallen
• GET /catalog/products — één pagina met producten, filterbaar op category En framework, tot 50 per pagina
• GET /catalog/products/{slug} — een enkel product op zijn Engelse slug

Authenticatie en schrijfbewerkingen

Er is er geen, en er zijn er geen. Elk eindpunt is een anonieme GET. Niets hier creëert een bestelling, verandert een prijs of raakt een account aan, dus er is geen sleutel om te lekken en geen status om schade aan te richten.

OpenAPI specificatie

De volledige machine-leesbare beschrijving, gegenereerd uit hetzelfde contract waarop de API is geïmplementeerd, zodat de twee niet kunnen afwijken:

• https://fivemx.com/openapi.json
• https://fivemx.com/.well-known/openapi.json — byte-identiek, voor clients die daar eerst kijken
• https://fivemx.com/.well-known/api-catalog — een RFC 9727 linkset die naar beide verwijst

De homepage adverteert het ook met een rel="service-desc" link, en https://fivemx.com/llms.txt beschrijft de site voor taalmodellen.

De FiveMX CLI

Een officiële command-line tool omhult dezelfde API. Node 18 of nieuwer, nul runtime-afhankelijkheden.

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

Exit codes scheiden een gebruiks­fout van een storing zonder enige output te parsen: 0 ok, 1 gebruiks­fout zonder verzonden verzoek, 2 het verzoek is mislukt, 3 de bron bestaat niet.

Foutreacties

Fouten zijn JSON, nooit een HTML pagina, en elk bevat een code, een bericht en een hint die zegt wat je vervolgens moet doen.

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

Een client die Accept: application/json, of die zichzelf identificeert als een bekende AI-agent, ontvangt deze vorm voor elk ontbrekend pad op de site, niet alleen binnen de API-namespace. Een browser behoudt de normale foutpagina.

Rate limits en caching

Er is geen gepubliceerde quota. Antwoorden worden tien minuten lang in de cache opgeslagen bij de oorsprong, dus een crawl van de hele catalogus is goedkoop voor beide partijen. Stuur een user agent die je identificeert, en geef de voorkeur aan één gepagineerde doorgang boven vele enkele productaanvragen.

Wat deze API bewust niet doet

• Het stelt geen winkelwagens, checkout, bestellingen, klanten of downloads bloot. Die paden zijn gesloten voor crawlers in robots.txt en worden niet beschreven door de specificatie.
• Het vertaalt geen slugs. Locale versies van de site gebruiken vertaalde URL's, en deze API accepteert alleen de Engelse slug.
• Het converteert geen prijzen. Waarden zijn in de basisvaluta die wordt gerapporteerd door /catalog, niet in de geselecteerde valuta van een bezoeker.
• Er is geen MCP-server, geen agentkaart en geen webhook-feed. Wanneer er een bestaat, wordt deze hier en in de API-catalogus vermeld in plaats van aangekondigd door een leeg bestand.

Vragen over de API horen thuis op de FiveMX contactpagina.