Quick Start
Fast onboarding path for developers integrating with Topolo services.
1. Identify the target service
Use the Service Registry to confirm the service name, owning repo, and whether the service exposes generated OpenAPI reference.
2. Authenticate against Topolo Auth
Topolo Auth is the entrypoint for user identity, organization membership, and service-level authorization. Use the auth flow documented in Authentication before calling application APIs or operator endpoints.
3. Request the minimum API key scopes
API keys are centrally managed and validated by Topolo Auth. Choose the smallest scope set and, when supported, bind the key to the narrowest allowed resource surface.
4. Validate the API contract
- Generated OpenAPI summaries are available for services that already ship a spec.
- Curated platform docs cover services without formal specs yet.
- Internal builds add debugging entrypoints and failure-mode guidance when you need to trace behavior across services.
5. Keep docs and implementation together
Platform or API changes are expected to land with matching docs updates. The docs CI workflow validates schema, build output, and minimal coverage for the phase-one systems.