Plataforma para Programadores

A documentação para programadores da FabHub é o ponto de entrada público canónico para a API, o SDK, as ferramentas MCP, os webhooks, a autenticação e o material de referência de contratos. Tudo aqui descreve a superfície pública servida a partir de https://api.fabhub.app/v1.

O que está disponível

API REST pública em https://api.fabhub.app/v1, descrita por OpenAPI.
SDK oficial em TypeScript (@fabhub/sdk) para integrações tipadas no lado do servidor.
Servidor MCP curado (@fabhub/mcp) cujas ferramentas mapeiam um-para-um com os scopes da API pública.
Webhooks de saída assinados, com um contrato de eventos AsyncAPI gerado.
Chaves de API para automação detida pelo tenant e OAuth para aplicações parceiras aprovadas.

Convenções

URL base: https://api.fabhub.app/v1. Todos os caminhos nesta referência são relativos a ele.
Formato: os corpos de pedido e de resposta são JSON; os corpos de pedido usam chaves em camelCase.
Parâmetros de consulta usam snake_case (por exemplo page_size, contact_types).
IDs são strings UUID. Timestamps são ISO 8601 em UTC (por exemplo 2026-06-20T09:30:00Z).
Autenticação: envie uma chave de API no cabeçalho X-API-Key (ou Authorization: Bearer). Consulte Autenticação.
Campos monetários (salePrice, purchasePrice) são números na moeda base do tenant, ou null.

Conceitos centrais

Tenant: cada credencial pertence a um tenant (organização); todos os dados têm âmbito de tenant.
Scopes: as chaves carregam scopes de privilégio mínimo, tais como items:read ou webhooks:write.
Idempotência: os pedidos de escrita aceitam um Idempotency-Key para que as repetições sejam seguras. Consulte Idempotência.
Paginação: as listas são baseadas em páginas; a exportação de auditoria é baseada em cursor. Consulte Paginação.
Erros: um envelope JSON estável com um code legível por máquina. Consulte Erros.

Snapshot atual do contrato

Versão OpenAPI: 1.0.0
Operações públicas: 47
Scopes públicos: 15
Canais de webhook: 14
Ferramentas MCP: 45

Comece por aqui

Contratos transferíveis

Documentos-fonte de segurança pública

O portal é gerado a partir de fontes de plataforma para programadores seguras para o público, registadas em docs/developer-platform/docs-source-registry.json:

docs/developer-platform/api-changelog.md
docs/developer-platform/enterprise-controls.md
docs/developer-platform/hosted-mcp.md
docs/developer-platform/openapi-breaking-change-policy.md
docs/developer-platform/scope-taxonomy.md
docs/developer-platform/usage-endpoint.md
docs/developer-platform/webhook-events.md
docs/developer-platform/versioning-and-deprecation.md

O que está disponível

API REST pública em https://api.fabhub.app/v1, descrita por OpenAPI.

SDK oficial em TypeScript (@fabhub/sdk) para integrações tipadas no lado do servidor.

Servidor MCP curado (@fabhub/mcp) cujas ferramentas mapeiam um-para-um com os scopes da API pública.

Webhooks de saída assinados, com um contrato de eventos AsyncAPI gerado.

Chaves de API para automação detida pelo tenant e OAuth para aplicações parceiras aprovadas.

Convenções

URL base: https://api.fabhub.app/v1. Todos os caminhos nesta referência são relativos a ele.

Formato: os corpos de pedido e de resposta são JSON; os corpos de pedido usam chaves em camelCase.

Parâmetros de consulta usam snake_case (por exemplo page_size, contact_types).

IDs são strings UUID. Timestamps são ISO 8601 em UTC (por exemplo 2026-06-20T09:30:00Z).

Autenticação: envie uma chave de API no cabeçalho X-API-Key (ou Authorization: Bearer). Consulte Autenticação.

Campos monetários (salePrice, purchasePrice) são números na moeda base do tenant, ou null.

Conceitos centrais

Tenant: cada credencial pertence a um tenant (organização); todos os dados têm âmbito de tenant.

Scopes: as chaves carregam scopes de privilégio mínimo, tais como items:read ou webhooks:write.

Idempotência: os pedidos de escrita aceitam um Idempotency-Key para que as repetições sejam seguras. Consulte Idempotência.

Paginação: as listas são baseadas em páginas; a exportação de auditoria é baseada em cursor. Consulte Paginação.

Erros: um envelope JSON estável com um code legível por máquina. Consulte Erros.

Documentos-fonte de segurança pública

O portal é gerado a partir de fontes de plataforma para programadores seguras para o público, registadas em docs/developer-platform/docs-source-registry.json:

docs/developer-platform/api-changelog.md

docs/developer-platform/enterprise-controls.md

docs/developer-platform/hosted-mcp.md

docs/developer-platform/openapi-breaking-change-policy.md

docs/developer-platform/scope-taxonomy.md

docs/developer-platform/usage-endpoint.md

docs/developer-platform/webhook-events.md

docs/developer-platform/versioning-and-deprecation.md