FiveMX Portal de Desarrollador

FiveMX publikuje tylko do odczytu API HTTP w swoim katalogu skryptów FiveM, opis w formacie OpenAPI 3.1 oraz narzędzie wiersza poleceń, które się z nim komunikuje. Wszystko na tej stronie jest publiczne, nie wymaga klucza i może być używane przez osobę, skrypt lub agenta.

Katalog FiveMX API

Jedna przestrzeń nazw, cztery punkty końcowe GET, tylko JSON. Udostępnia te same 1.675 opublikowanych produktów, co sklep, z cenami w walucie bazowej sklepu, stanem magazynowym, kategorią i tagami frameworka.

Podstawowy adres URL

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

Punkty końcowe

• GET /catalog — indeks z liczbą elementów, walutą i linkami do wszystkiego innego na tej stronie
• GET /catalog/categories — wszystkie 46 kategorii z liczbą produktów
• GET /catalog/products — jedna strona produktów, z możliwością filtrowania według category I framework, do 50 na stronę
• GET /catalog/products/{slug} — pojedynczy produkt według jego angielskiego sluga

Uwierzytelnianie i zapisy

Nie ma żadnego i nie ma żadnych. Każdy punkt końcowy to anonimowy GET. Nic tutaj nie tworzy zamówienia, nie zmienia ceny ani nie dotyka konta, więc nie ma klucza do wycieku ani stanu, który można by uszkodzić błędem.

Specyfikacja OpenAPI

Pełny opis czytelny dla maszyn, wygenerowany na podstawie tej samej umowy, co implementacja API, dzięki czemu te dwa elementy nie mogą się rozbiec:

• https://fivemx.com/openapi.json
• https://fivemx.com/.well-known/openapi.json — identyczny bajtowo, dla klientów, którzy tam najpierw sprawdzają
• https://fivemx.com/.well-known/api-catalog — linkset RFC 9727 wskazujący na oba

Strona główna również reklamuje go za pomocą rel="service-desc" linku, a https://fivemx.com/llms.txt opisuje witrynę dla modeli językowych.

FiveMX CLI

Oficjalne narzędzie wiersza poleceń opakowuje to samo API. Node 18 lub nowszy, zero zależności w czasie wykonania.

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

Kody wyjścia oddzielają błąd użycia od awarii bez analizowania żadnych danych wyjściowych: 0 ok, 1 błąd użycia bez wysłanego żądania, 2 żądanie nie powiodło się, 3 zasób nie istnieje.

Odpowiedzi błędów

Błędy to JSON, nigdy strona HTML, a każdy z nich zawiera kod, komunikat i wskazówkę, co robić dalej.

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

Klient, który wysyła Accept: application/json, lub który identyfikuje się jako znany agent AI, otrzymuje taki kształt dla każdej brakującej ścieżki na stronie, nie tylko w przestrzeni nazw API. Przeglądarka zachowuje normalną stronę błędu.

Limity żądań i buforowanie

Nie ma opublikowanego limitu. Odpowiedzi są buforowane przez dziesięć minut u źródła, więc przeszukiwanie całego katalogu jest niedrogie dla obu stron. Proszę wysłać identyfikator użytkownika, który Cię identyfikuje, i preferuj jedno przejście stronicowane zamiast wielu żądań pojedynczych produktów.

Czego ten API celowo nie robi

• Nie udostępnia koszyków, procesu realizacji zakupu, zamówień, klientów ani pobrań. Te ścieżki są zamknięte dla robotów w robots.txt i nie są opisane przez specyfikację.
• Nie udostępnia przetłumaczonych slugów. Wersje strony w różnych językach używają przetłumaczonych adresów URL, a ten API akceptuje tylko angielski slug.
• Nie przelicza cen. Wartości są w walucie bazowej zgłoszonej przez /catalog, a nie w walucie wybranej przez odwiedzającego.
• Nie ma serwera MCP, karty agenta ani kanału webhook. Gdy taki istnieje, zostanie on wymieniony tutaj i w katalogu API, zamiast być ogłoszonym przez pusty plik.

Pytania dotyczące API należą do FiveMX contact page.