FiveMX pubblica un HTTP API di sola lettura sul suo catalogo di script FiveM, una descrizione OpenAPI 3.1 di esso e uno strumento a riga di comando che comunica con esso. Tutto in questa pagina รจ pubblico, non richiede chiavi e puรฒ essere utilizzato da una persona, uno script o un agente.
Il catalogo FiveMX API
Un namespace, quattro endpoint GET, JSON solo. Espone gli stessi 1.675 prodotti pubblicati del negozio, con prezzi nella valuta base del negozio, scorte, categoria e tag del framework.
URL di base
https://fivemx.com/wp-json/fivemx/v1Endpoint
GET /catalogโ indice con conteggi, valuta e link a tutto il resto in questa paginaGET /catalog/categoriesโ tutte le 46 categorie con conteggio prodottiGET /catalog/productsโ una pagina di prodotti, filtrabile percategoryEframework, fino a 50 per paginaGET /catalog/products/{slug}โ un singolo prodotto tramite il suo slug inglese
Autenticazione e scritture
Non ce n'รจ nessuna, e non ce ne sono. Ogni endpoint รจ un GET anonimo. Niente qui crea un ordine, cambia un prezzo o tocca un account, quindi non c'รจ nessuna chiave da divulgare e nessuno stato da danneggiare con un errore.
Specifiche OpenAPI
La descrizione completa leggibile dalla macchina, generata dallo stesso contratto contro cui รจ implementato il API, in modo che i due non possano divergere:
https://fivemx.com/openapi.jsonhttps://fivemx.com/.well-known/openapi.jsonโ byte identico, per i client che guardano prima lรฌhttps://fivemx.com/.well-known/api-catalogโ un linkset RFC 9727 che punta a entrambi
La homepage lo pubblicizza anche con un rel="service-desc" link, e https://fivemx.com/llms.txt descrive il sito per i modelli linguistici.
Il FiveMX CLI
Uno strumento da riga di comando ufficiale racchiude lo stesso API. Node 18 o versioni successive, zero dipendenze runtime.
npm install -g @fivemx/cli
fivemx catalog
fivemx products --framework qbcore --per-page 5
fivemx product audio-speaker-script --jsonI codici di uscita separano un errore di utilizzo da un'interruzione senza analizzare alcun output: 0 ok, 1 errore di utilizzo senza richiesta inviata, 2 la richiesta รจ fallita, 3 la risorsa non esiste.
Risposte di errore
Gli errori sono JSON, mai una pagina HTML, e ognuno porta un codice, un messaggio e un suggerimento che dice cosa fare dopo.
{
"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 che invia Accept: application/json, o che si identifica come un agente AI noto, riceve questa forma per qualsiasi percorso mancante sul sito, non solo all'interno dello spazio dei nomi API. Un browser mantiene la normale pagina di errore.
Limiti di frequenza e caching
Non esiste una quota pubblicata. Le risposte vengono memorizzate nella cache per dieci minuti all'origine, quindi l'esplorazione dell'intero catalogo รจ economica per entrambe le parti. Invia un user agent che ti identifichi e preferisci un passaggio paginato a molte richieste di singoli prodotti.
Cosa questo API deliberatamente non fa
- Non espone carrelli, checkout, ordini, clienti o download. Questi percorsi sono chiusi ai crawler in
robots.txte non sono descritti dalla specifica. - Non serve slug tradotti. Le versioni locali del sito utilizzano URL tradotti, e questo API accetta solo lo slug inglese.
- Non converte i prezzi. I valori sono nella valuta di base riportata da
/catalog, non nella valuta selezionata da un visitatore. - Non c'รจ server MCP, nessuna scheda agente e nessun feed webhook. Quando esisterร uno, sarร elencato qui e nel catalogo API piuttosto che annunciato da un file vuoto.
Le domande sul API appartengono al Pagina di contatto FiveMX.
