Carbob API

Documentação Interativa dos Endpoints de Autenticação

v1.0.0

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

Guia de Arquitetura

Documentação completa de arquitetura, padrões e exemplos de desenvolvimento da API.

  • Regras de arquitetura
  • Padrões de desenvolvimento
  • Exemplos práticos
  • Busca integrada
Abrir Guia

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

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

Desenvolvido com Laravel Passport e Swagger UI

Base URL: https://api.carbob.pt | Desenvolvimento: http://api.carbob.local