FiveMX Portal do Desenvolvedor

FiveMX publica um API HTTP somente leitura sobre seu catálogo de scripts FiveM, uma descrição OpenAPI 3.1 dele e uma ferramenta de linha de comando que se comunica com ele. Tudo nesta página é público, não precisa de chave e pode ser usado por uma pessoa, um script ou um agente.

O catálogo FiveMX API

Um namespace, quatro endpoints GET, JSON apenas. Ele expõe os mesmos 1.675 produtos publicados que a loja, com preços na moeda base da loja, estoque, categoria e tags de framework.

URL base

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

Endpoints

• GET /catalog — índice com contagens, moeda e links para todo o resto nesta página
• GET /catalog/categories — todas as 46 categorias com contagem de produtos
• GET /catalog/products — uma página de produtos, filtrável por category e framework, até 50 por página
• GET /catalog/products/{slug} — um único produto pelo seu slug em inglês

Autenticação e gravações

Não há nenhum, e não há nenhum. Cada endpoint é um GET anônimo. Nada aqui cria um pedido, altera um preço ou mexe em uma conta, então não há chave para vazar e nenhum estado para um erro danificar.

Especificação OpenAPI

A descrição completa legível por máquina, gerada a partir do mesmo contrato que o API é implementado, para que os dois não possam divergir:

• https://fivemx.com/openapi.json
• https://fivemx.com/.well-known/openapi.json — byte idêntica, para clientes que olham lá primeiro
• https://fivemx.com/.well-known/api-catalog — um linkset RFC 9727 apontando para ambos

A página inicial também a anuncia com um rel="service-desc" link, e https://fivemx.com/llms.txt descreve o site para modelos de linguagem.

O FiveMX CLI

Uma ferramenta oficial de linha de comando encapsula o mesmo API. Node 18 ou mais recente, zero dependências de tempo de execução.

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

Códigos de saída separam um erro de uso de uma interrupção sem analisar nenhuma saída: 0 ok, 1 erro de uso sem solicitação enviada, 2 a solicitação falhou, 3 o recurso não existe.

Respostas de erro

Erros são JSON, nunca uma página HTML, e cada um carrega um código, uma mensagem e uma dica que diz o que fazer a seguir.

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

Um cliente que envia Accept: application/json, ou que se identifica como um agente de IA conhecido, recebe esta forma para qualquer caminho ausente no site, não apenas dentro do namespace API. Um navegador mantém a página de erro normal.

Limites de taxa e cache

Não há cota publicada. As respostas são armazenadas em cache por dez minutos na origem, tornando a varredura de todo o catálogo barata para ambos os lados. Por favor, envie um user agent que o identifique e prefira uma passagem paginada a muitas solicitações de produto único.

O que este API deliberadamente não faz

• Ele não expõe carrinhos, checkout, pedidos, clientes ou downloads. Esses caminhos estão fechados para crawlers em robots.txt e não são descritos pela especificação.
• Ele não serve slugs traduzidos. Versões localizadas do site usam URLs traduzidas, e este API aceita apenas o slug em inglês.
• Ele não converte preços. Os valores estão na moeda base informada por /catalog, não na moeda selecionada pelo visitante.
• Não há servidor MCP, nem cartão de agente e nem feed de webhook. Quando um existir, ele será listado aqui e no catálogo API em vez de ser anunciado por um arquivo vazio.

Perguntas sobre o API devem ser feitas no Página de contato FiveMX.