Overview
The Developer Guides section provides task-oriented guides for building, extending, and integrating with the Keymate platform. Each subsection focuses on a distinct development workflow — from authoring authorization policies to publishing events, customizing enforcement plugins, and extending identity services.
Sections at a Glance
| Section | What It Covers | Status |
|---|---|---|
| Developer Tooling | FQL code editor, API explorer, authorization testing, and FGA playground | Partially available |
| Policy Development | Policy authoring with the visual Expression Builder, FQL expressions, JavaScript scripts, and resource modeling | Partially available |
| Integration Hub Development | Event producers, consumers, subscription management gRPC/REST APIs, and Access Gateway integration | Available |
| Enforcement Plugin Customization | Extending and contributing to API gateway, reverse proxy, and service mesh authorization enforcement plugins | Planned |
| Identity & Extension Development | Keycloak SPI development, Keymate SPI extension patterns, and authorization orchestration | Planned |
Where to Start
Choose your starting point based on what you need to do:
- Author policies — Start with Policy Authoring with DSL to learn FQL syntax, or GUI-Based Policy Authoring for the visual Expression Builder.
- Use the FQL editor — See Policy DSL Tooling for auto-completion, validation, and formatting features.
- Integrate with Integration Hub — Start with Building Producers to publish events, or Building Consumers to receive them.
- Manage subscriptions programmatically — See Using Integration Hub gRPC APIs for the full gRPC and REST API reference.
Related Sections
- Platform Components — Architecture and component documentation for each Keymate service
- Concepts — Mental models for authorization, identity, policy, and organization
- SDKs — Client SDK guides for Java, TypeScript, Go, and .NET
- Reference — API specifications, DSL references, and configuration details