A API REST e a documentação de API do seu app

Às vezes, outros sistemas precisam dos dados do seu app: o site de um parceiro que lista os seus produtos, uma planilha que puxa os pedidos novos, um app de celular, uma ferramenta de automação como Zapier ou n8n. Eles conversam com o seu app por meio de uma API — um conjunto de endereços web (endpoints) que respondem com dados em vez de páginas. A API REST é o tipo mais comum.

O MonstarX cria uma para você, sem código. Você escolhe o que compartilhar, e em segundos ela está no ar, com uma página de referência que os desenvolvedores podem ler.

Onde encontro?

Abra o seu projeto, clique em Admin na barra superior e depois em APIs, na barra lateral do Admin. Aparece a tela APIs do projeto: no topo, a barra Referência da API, que publica a documentação da sua API; à esquerda, os seus endpoints, cada um marcado como Ativo ou Rascunho; e, abaixo deles, Chaves de API.

Como crio um endpoint?

1. Em Admin›APIs, clique em Novo endpoint (ou no + ao lado de Endpoints).

2. Escolha a Coleção — a tabela com que o endpoint trabalha, como Receitas.

3. Escolha a Operação:

   Operação	Método e endereço	O que faz
   Listar	GET /recipes	Retorna os registros, uma página por vez.
   Obter	GET /recipes/{id}	Retorna um registro pelo id.
   Criar	POST /recipes	Adiciona um registro.
   Atualizar	PATCH /recipes/{id}	Altera alguns campos de um registro.
   Excluir	DELETE /recipes/{id}	Remove um registro.

4. Dê a ele um Nome, um Caminho da URL e, se quiser, uma Descrição. Eles aparecem na documentação da API.

5. Em Campos expostos, marque exatamente os campos que quem chama pode ver ou enviar. O que ficar desmarcado continua privado. Campos que parecem sensíveis, como senhas e tokens, ficam sempre de fora.

6. Em Acesso, escolha quem pode chamar o endpoint (veja abaixo).

7. Marque Publicar endpoint e clique em Salvar e publicar endpoint. Um endpoint publicado fica Ativo: ele responde às solicitações na hora. Se deixar a caixa desmarcada, Salvar endpoint guarda o endpoint como Rascunho.

   

Na lista, cada endpoint mostra Ativo ou Rascunho. A mesma palavra aparece em Editar endpoint, seguida de Alterações não salvas até você salvar. Para tirar um endpoint do ar sem excluí-lo, desmarque Publicar endpoint e salve; Excluir remove o endpoint.

Nota

Criar, Atualizar e Excluir alteram os seus dados reais. Antes de publicar um desses, ative a ação correspondente (adicionar, editar ou excluir) para a tabela nas configurações dela na aba Admin. Veja O painel Admin do seu app.

Quem pode chamar os meus endpoints?

Acesso	Quem pode chamar	Permitido para
Leitura pública	Qualquer pessoa com o endereço.	Só Listar e Obter
Chave de API do projeto	Só quem envia uma das chaves de API do seu projeto.	Todas as operações

Endpoints que alteram dados sempre exigem uma chave.

Como crio uma chave de API?

1. Em Admin›APIs, clique em Chaves de API.

2. Digite um nome que diga onde a chave vai ser usada, como “Servidor do widget de receitas”, e clique em Criar chave.

3. Copie a chave na hora — ela começa com mxapi_ e não pode ser exibida de novo. Guarde-a em um lugar seguro, como um gerenciador de senhas ou os segredos do outro serviço.

Uma chave abre todos os endpoints protegidos por chave do projeto, então dê a cada serviço a sua própria chave. Clique em Revogar para desligar uma chave; tudo o que a usa para de funcionar na hora.

Quem chama envia a chave no cabeçalho Authorization: Authorization: Bearer mxapi_….

Cuidado

Mantenha as chaves de API em um servidor. Uma chave colocada em uma página web ou em um app de celular pode ser lida por qualquer pessoa que procurar.

Como testo um endpoint?

Abra o endpoint e clique em Testar. Informe o ID do registro, a Chave bearer ou o Corpo JSON, se o endpoint precisar, e clique em Enviar solicitação. Você vê o status (200 significa que deu certo), quanto tempo levou e a resposta. Para um endpoint que exige chave, cole uma das suas chaves de Chaves de API em Chave bearer.

Os testes vão para o endpoint real, no ar, então:

• Um rascunho ainda não pode ser testado. A aba Testar mostra Este endpoint é um rascunho; clique em Salvar e publicar endpoint ali mesmo para publicá-lo e testá-lo.
• Salve as alterações antes. Com alterações não salvas, a aba Testar pede para você salvar antes de testar, com um botão Salvar endpoint.

Um teste de Criar, Atualizar ou Excluir altera os seus dados reais.

A aba Código traz um comando cURL pronto para copiar e o arquivo OpenAPI JSON, que ferramentas de API como Postman e Insomnia conseguem importar.

Como publico e compartilho a documentação da minha API?

A documentação da sua API é uma página de Referência da API para desenvolvedores: todos os endpoints ativos, os campos de cada um, se exigem chave, um campo Experimentar e um exemplo em cURL. Publicar um endpoint não publica a documentação — você escolhe quando compartilhá-la.

1. Publique pelo menos um endpoint e salve todas as alterações. Até lá, a barra Referência da API no topo de Admin›APIs mostra Não publicado e diz o que está faltando.

2. Clique em Publicar documentação.

   

3. A barra passa a mostrar Publicado. Clique em Copiar link da documentação para compartilhar o endereço ou em Abrir documentação da API, abaixo de Chaves de API, para ver a página. O endereço é parecido com https://monstarx.com/api-docs/<your project id>.

monstarx.com

A página abre com o nome e a descrição do projeto, quantos endpoints ela lista, o ID do projeto e o endereço base. Qualquer pessoa com o link consegue ler a página, e os mecanismos de busca são instruídos a não indexá-la. Ela mostra só endpoints ativos e nunca mostra chaves. O link OpenAPI JSON no topo leva à mesma descrição em forma de arquivo.

Para tirar a documentação do ar, clique em Tirar documentação do ar: a página e o arquivo OpenAPI param de funcionar, mas os endpoints continuam respondendo. Se você tirar todos os endpoints do ar, a documentação também sai do ar, e você a publica de novo quando estiver pronto.

Como são as solicitações e as respostas?

Todo endpoint fica em https://monstarx.com/api/rest/<your project id>, seguido do caminho dele.

Listar

curl 'https://monstarx.com/api/rest/<project id>/recipes?page=1&limit=25'

{
  "data": [
    { "id": "41a6…", "title": "Street tacos al pastor", "country_code": "MX" }
  ],
  "page": 1,
  "limit": 25,
  "hasMore": false
}

limit vai de 1 a 100 registros por página (25 se você não informar) e page vai de 1 a 100. hasMore indica se existe outra página.

Criar

curl -X POST 'https://monstarx.com/api/rest/<project id>/recipes' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Lemon ricotta pancakes", "country_code": "IT"}'

A resposta (status 201) traz o novo registro em data, com o id dele.

Atualizar e excluir

curl -X PATCH 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Fluffy lemon ricotta pancakes"}'

curl -X DELETE 'https://monstarx.com/api/rest/<project id>/recipes/RECORD_ID' \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY'

Atualizar responde com o registro alterado; Excluir responde { "deleted": true }.

Regras para o que você envia:

• Um objeto JSON com Content-Type: application/json, de até 64 KB.
• Só campos expostos, cada um com um valor simples: texto (até 20.000 caracteres), número, true/false ou null.
• O id não pode ser definido nem alterado, assim como os campos que são somente leitura no Admin.

Quando algo dá errado, a resposta traz uma mensagem em error e um status: 400 (a solicitação não está correta), 401 (é preciso uma chave de API do projeto válida), 403 (essa tabela ou ação não está permitida no Admin), 404 (endpoint ou registro inexistente), 409 (um conflito, como um registro duplicado), 413 (a resposta passaria de 1 MB — exponha menos campos ou use uma página menor).

Perguntas frequentes

Por que não consigo clicar em Publicar documentação?

A documentação precisa de pelo menos um endpoint ativo e de nenhuma alteração não salva. Marque Publicar endpoint em um endpoint, clique em Salvar e publicar endpoint e depois em Publicar documentação.

Preciso publicar o app para a API funcionar?

Não. A API lê e grava direto no banco de dados do projeto, então funciona assim que um endpoint é publicado. Ela usa os mesmos dados da prévia e do app no ar, e não precisa de criação, de IA nem de créditos.

Um site pode chamar a minha API pelo navegador?

Sim, qualquer site pode chamar os seus endpoints. Use endpoints de Leitura pública em páginas web e deixe as chamadas protegidas por chave em um servidor, para a chave continuar secreta.

Perdi uma chave de API. Consigo vê-la de novo?

Não, a chave é exibida uma única vez. Crie uma nova chave, passe o serviço a usá-la e depois clique em Revogar na antiga.

Por que não consigo publicar um endpoint?

Para Criar, Atualizar ou Excluir, ative antes essa ação para a tabela no Admin. Um app cujo banco de dados em produção roda na sua própria conta Cloudflare não pode publicar endpoints pelo MonstarX, porque o banco de dados aqui guarda os dados de prática da prévia.

Posso receber webhooks quando os dados mudam?

Não pelo Admin → APIs, que responde a solicitações. Peça ao MonstarX para adicionar um webhook ao seu app — por exemplo, “quando um pedido for feito, envie um POST com ele para este endereço”.

Veja também

O painel Admin do seu appOnde ficam as APIs, junto com as tabelas, os usuários e a atividade.

O banco de dados do seu appAs tabelas que os seus endpoints leem e gravam.

Segredos e chaves de APIChaves que o seu app usa para outros serviços.

Conecte o Claude Code, o Codex ou o Cursor ao MonstarXComande o próprio MonstarX pelo Claude Code, Cursor e outros.