API REST

Construa sobre os seus projetos Skimle

Endpoints JSON para ler e escrever dados de projetos e executar um projeto do início ao fim. Autentique-se com uma chave Bearer, envie uma ação e receba JSON.

Comece em três passos

Do zero à sua primeira chamada autenticada.

1

Crie uma chave de API

Uma chave de projeto dá acesso a um projeto. Uma chave de conta dá acesso a uma equipa e pode criar projetos nela. Ambas existem com nível de leitura e de edição.

  1. 1. Abra a página de chaves de API
  2. 2. Escolha o projeto a que a chave deve aceder e o acesso de leitura ou edição
  3. 3. Copie a chave: a Skimle só guarda o respetivo hash

Copie a chave de imediato.

O valor completo da chave só é mostrado uma vez, quando é criada. Depois de fechar a janela, do nosso lado fica apenas o hash. Uma chave perdida tem de ser emitida de novo.

2

Envie o seu primeiro pedido

Envie a chave como token Bearer e a ação no corpo JSON. Todos os endpoints recebem e devolvem JSON.

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

As chaves de leitura terminam em r e as de edição em e. As chaves de projeto chamam /api/skimle-read e /api/skimle-write. As chaves de conta chamam /api/skimle-account.

3

Abra a referência da API

Consulte todos os endpoints com descrições, formatos de pedido e um painel para os experimentar. Cada rota aceita um corpo em forma de união discriminada pela ação.

A especificação OpenAPI 3.1 em bruto está disponível em /api/openapi.json.

Pronto para começar?

Faça a gestão das suas chaves de projeto ou conheça o servidor MCP para clientes agênticos.