The components of a Hybrid architecture are divided into two parts:
| Component | Description |
|---|---|
| APIM Console (for API producers) | This web UI gives easy access to some key APIM Management API services. API publishers can use it to publish APIs. Administrators can also configure global platform settings and specific portal settings. |
| APIM Management API | This RESTful API exposes services to manage and configure the APIM Console and APIM Developer Portal web UIs. All exposed services are restricted by authentication and authorization rules. For more information, see the Management API Reference section. |
| APIM Developer Portal (for API consumers) | This web UI gives easy access to some key APIM API services. It allows API Consumers to manage their applications and search for, view, try out, and subscribe to a published API. |
[Optional] APIM SaaS API Gateways | APIM Gateway is the core component of the APIM platform. You can think of it like a smart reverse proxy. Unlike a traditional HTTP proxy, APIM Gateway has the capability to apply policies (i.e., rules or logic) to both the request and response phases of an API transaction. With these policies, you can transform, secure, monitor, etc., your APIs. |
| Bridge Server | A bridge API Gateway exposes extra HTTP services for bridging HTTP calls to the underlying repository (which can be any of our supported repositories: MongoDB, JDBC, etc.) |
| Config Database | All the API Management platform management data, such as API definitions, users, applications, and plans. |
| S3 Bucket + Analytics Database | Analytics and logs data. |
| Gravitee Cockpit | Gravitee Cockpit is a centralized, multi-environments / organizations tool for managing all your Gravitee API Management and Access Management installations in a single place. |
| [Optional] API Designer | Drag-and-Drop graphical (MindMap) API designer to quickly and intuitively design your APIs (Swagger / OAS) and deploy mocked APIs for quick testing. |
| [Optional] Alert Engine | Alert Engine (AE) provides APIM and AM users with efficient and flexible API platform monitoring, including advanced alerting configuration and notifications sent through their preferred channels, such as email, Slack and using Webhooks. AE does not require any external components or a database as it does not store anything. It receives events and sends notifications under the conditions which have been pre-configured upstream with triggers. |
| Component | Description |
|---|---|
| APIM Gateway | APIM Gateway is the core component of the APIM platform. You can think of it like a smart reverse proxy. Unlike a traditional HTTP proxy, APIM Gateway has the capability to apply policies (i.e., rules or logic) to both the request and response phases of an API transaction. With these policies, you can transform, secure, monitor, etc., your APIs. |
| Logstash | Collect and send local Gateway logs and metrics to the Gravitee APIM SaaS Control Plane. |
| Redis | The database used locally for rate limit synchronized counters (RateLimit, Quota, Spike Arrest) and, optionally, as an external cache for the Cache policy. |