FiveMX Geliştirici Portalı

FiveMX, salt okunur bir HTTP API'yi FiveM betik kataloğu, bunun bir OpenAPI 3.1 açıklaması ve onunla konuşan bir komut satırı aracı aracılığıyla yayınlar. Bu sayfadaki her şey herkese açıktır, anahtar gerektirmez ve bir kişi, bir betik veya bir aracı tarafından kullanılabilir.

FiveMX kataloğu API

Tek bir ad alanı, dört GET uç noktası, yalnızca JSON. Dükkanın yayınladığı 1.675 ürünü, mağaza temel para birimindeki fiyatları, stoğu, kategoriyi ve çerçeve etiketlerini aynı şekilde sunar.

Temel URL

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

Uç Noktalar

• GET /catalog — her şeyin bağlantılarını ve sayımlarını içeren dizin
• GET /catalog/categories — ürün sayımlarıyla birlikte tüm 46 kategori
• GET /catalog/products — ürünlere göre filtrelenebilen bir sayfa category Ve framework, sayfa başına 50 adede kadar
• GET /catalog/products/{slug} — İngilizce kısa adına göre tek bir ürün

Kimlik doğrulama ve yazma işlemleri

Yoktur ve hiçbiri yoktur. Her uç nokta anonim bir GET isteğidir. Burada hiçbir şey sipariş oluşturmaz, fiyatı değiştirmez veya hesaba dokunmaz, bu nedenle sızdırılacak bir anahtar yoktur ve hatanın zarar verebileceği bir durum yoktur.

OpenAPI spesifikasyonu

API'nin uygulandığı sözleşmeden oluşturulan tam makine tarafından okunabilir açıklama, böylece ikisi birbirinden sapamaz:

• https://fivemx.com/openapi.json
• https://fivemx.com/.well-known/openapi.json — İlk olarak oraya bakan istemciler için bayt olarak aynıdır
• https://fivemx.com/.well-known/api-catalog — Her ikisine de işaret eden bir RFC 9727 linkset

Ana sayfa ayrıca bunu bir rel="service-desc" bağlantı ile duyurur ve https://fivemx.com/llms.txt dil modelleri için siteyi açıklar.

FiveMX CLI

Aynı API'yi kapsülleyen resmi bir komut satırı aracı. Node 18 veya daha yenisi, sıfır çalışma zamanı bağımlılığı.

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

Çıkış kodları, herhangi bir çıktıyı ayrıştırmadan bir kullanım hatasını bir kesintiden ayırır: 0 tamam, 1 kullanım hatası, istek gönderilmedi, 2 istek başarısız oldu, 3 kaynak mevcut değil.

Hata yanıtları

Hatalar her zaman JSON'dir, asla HTML sayfası değildir ve her biri bir kod, bir mesaj ve bir sonraki adımı belirten bir ipucu içerir.

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

Gönderen bir istemci Accept: application/json, veya bilinen bir yapay zeka aracısı olarak kendini tanımlayan, sitedeki herhangi bir eksik yol için, yalnızca API ad alanı içinde değil, bu şekli alır. Bir tarayıcı normal hata sayfasını tutar.

Hız sınırları ve önbelleğe alma

Yayınlanmış bir kota bulunmamaktadır. Yanıtlar kaynakta on dakika boyunca önbelleğe alınır, bu nedenle tüm kataloğun taranması her iki taraf için de ucuzdur. Lütfen sizi tanımlayan bir kullanıcı aracısı gönderin ve birçok tekil ürün isteği yerine sayfalara ayrılmış tek bir geçişi tercih edin.

Bu API'nin kasıtlı olarak yapmadığı şeyler

• Sepetleri, ödeme işlemlerini, siparişleri, müşterileri veya indirmeleri sunmaz. Bu yollar tarayıcılar için kapalıdır robots.txt ve spesifikasyon tarafından tanımlanmamıştır.
• Çevrilmiş URL'leri sunmaz. Sitenin yerel sürümleri çevrilmiş URL'ler kullanır ve bu API yalnızca İngilizce URL'yi kabul eder.
• Fiyatları dönüştürmez. Değerler, ziyaretçinin seçtiği para biriminde değil, tarafından bildirilen temel para birimindedir /catalog, .
• MCP sunucusu, aracı kartı veya webhook akışı yoktur. Mevcut olduğunda, boş bir dosya yerine burada ve API kataloğunda listelenecektir.

API ile ilgili sorular şurada sorulmalıdır FiveMX iletişim sayfası.