Carbob API - Documentação

Sobre a API

A Carbob API é uma API multi-tenant com autenticação OAuth2 usando Laravel Passport. Todos os endpoints protegidos requerem os headers Authorization: Bearer <token> e X-TENANT-ID: <tenant_id>.

POST

/v1/register

POST

/v1/token

GET

/v1/health

GET

/v1/projects

Swagger UI

Interface interativa para testar todos os endpoints da API com autenticação integrada.

Teste endpoints diretamente no navegador
Autenticação integrada
Documentação interativa
Exemplos de requests/responses

Abrir Swagger UI

Documentação Completa

Documentação detalhada em Markdown com exemplos de uso, códigos de status e fluxo de autenticação.

Exemplos com cURL
Códigos de erro detalhados
Fluxo de autenticação
Notas de segurança

Ver Documentação

Coleção Postman

Coleção completa do Postman com todos os endpoints, variáveis de ambiente e testes automatizados.

Variáveis de ambiente
Testes automatizados
Scripts de autenticação
Organização por categorias

Download Postman

Especificação OpenAPI

Especificação OpenAPI 3.0.3 completa para gerar SDKs e documentação automática.

Especificação OpenAPI 3.0.3
Schemas completos
Compatível com Swagger
Geração de SDKs

Ver OpenAPI Spec

Como Começar

Registro: Use POST /v1/register para criar uma nova conta e tenant
Autenticação: Use POST /v1/token para obter um token de acesso
Teste: Use o Swagger UI para testar endpoints interativamente
Integração: Use a coleção Postman ou gere SDKs a partir da especificação OpenAPI