API For Developers
Document information
- Canonical URL:
/docs/08_api-for-developers/00_introduction - Version:
2026-05-08 - Tags:
api,developers,openapi
This section helps you integrate external systems with Tealfabric through HTTP APIs. It is designed for developers building backend integrations, automation pipelines, and service-to-service workflows that need secure, predictable access to platform data and operations.
What you will find in this section
You can use this section as a practical entry point for API discovery, authentication setup, and schema-level contract validation. The pages are organized to help you move from understanding available endpoints to implementing production-safe calls with the right key scopes and security practices.
If you are starting from scratch, begin with the interactive OpenAPI view to inspect endpoints and example payloads, then configure API keys for your integration environment. This order helps you reduce setup friction and validate requests earlier in development.
Recommended reading path
Start with the API endpoint overview for a narrative understanding of what each endpoint group does in real workflows. Then use the OpenAPI/Swagger reference to test request and response shapes directly before wiring those calls into your own services.
After endpoint exploration, review API key management to configure scoped credentials and operational practices such as rotation and revocation. If you need schema-level details for contract reviews or client generation, continue with the API specification page.
Connect to related sections
Developer API work is most effective when paired with security and automation guidance. Use the security section for key hygiene and compliance controls, and use the ProcessFlow section when your integration triggers or monitors automations through API calls.
This section is the foundation for reliable API adoption in Tealfabric. Once you complete it, you should be ready to build, secure, and operate production integrations with confidence.