Launch offer: 50% off.Paid plans only.See pricing
Skip to content

Documentation

Reference

API Overview

Base URLs, headers, result wrappers, and error contract patterns.


Base URLs

Platform API

  • Test: https://test.api.uselamba.com/api/v1
  • Production: https://api.uselamba.com/api/v1
  • Local: http://localhost:8080/api/v1

BFF

  • Test: https://test.api.uselamba.com/platform
  • Production: https://api.uselamba.com/platform
  • Local: http://localhost:8080/platform

Gateway routing

  • /platform/* -> BFF
  • /api/v1/* -> Platform API
  • /web3/* -> Web3 API
  • /oidc/* -> OIDC API

Common headers

Authorization: Bearer <access-token>
X-Tenant-Id: <tenant-guid>
X-Project-Id: <project-guid>
X-Correlation-Id: <guid-or-string>

Success and error contracts

  • Success: { data, isSuccess, message }
  • Empty success: { isSuccess, message }
  • Errors: ProblemDetails (title, status, type, detail) + optional errorCode

Core surfaces

  • Auth: login, register, refresh, logout
  • Tenant/project: tenant detail, projects, audit logs
  • Tenant settings: branding, templates, auth policies
  • Webhooks: endpoint CRUD and delivery logs
  • Domains: add/verify/delete tenant domains

Implementation notes

  • Keep client-level error normalization centralized.
  • Always pass correlation IDs for distributed tracing.
  • Build typed clients around contract wrappers, not raw fetch everywhere.

Related docs

  • Request scoping: /docs/concepts/request-scoping
  • Error contracts: /docs/reference/errors
  • OpenAPI and Postman: /docs/reference/openapi-postman