# REST API do Sig.Surf

Fonte: https://sig.surf/pt/integrations/rest-api (versão em Markdown da página)

Uma API em JSON para criar assinaturas e gerenciar colaboradores, com uma descrição OpenAPI em uma URL estável.

> As assinaturas feitas por esta interface são para o Gmail e o Google Workspace.

## O que você pode fazer

- `POST /api/v1/signatures` sem credenciais recebe o id de um modelo ou um documento de assinatura mais os valores dos campos, e retorna HTML renderizado, texto simples, avisos e um link de resgate. Alguém faz login depois e resgata a assinatura; as assinaturas não resgatadas expiram após 30 dias.
- Com uma chave de API, liste e atualize os colaboradores da sua organização.
- Liste o catálogo de modelos.

## Convenções

- JSON na entrada e na saída. Os erros têm o formato `{ "error": { "code", "message" } }`, com o status HTTP correspondente.
- As chaves de API começam com `ssk_`, atuam em nome de uma única organização e são enviadas como token bearer. Só um hash de cada chave é armazenado.
- Os corpos das requisições são limitados a 64 KiB. Chamadas anônimas têm limite de taxa, e você recebe `429` com um cabeçalho `Retry-After`.
- O documento OpenAPI 3.1 está em `/api/v1/openapi.json`.

Para assistentes que falam MCP, veja o [servidor MCP](https://sig.surf/pt/integrations/mcp-server).
