Gateway Products¶
Gateway products define API access tiers for enterprises using DIBOP. They control which APIs are available, how many calls can be made, and at what rate -- similar to API management products in platforms like Azure API Management.
What Are Gateway Products?¶
A gateway product is a named bundle of API access permissions and limits. When a Platform Admin provisions an enterprise, they assign one or more gateway products that define:
- Which APIs the enterprise can access
- How many calls the enterprise can make (quota)
- How fast the enterprise can make calls (rate limit)
- What response data is included (some products may filter or restrict fields)
Standard Products¶
DIBOP provides three standard gateway products:
Free Tier¶
| Setting | Value |
|---|---|
| API Access | Public APIs only (NHTSA, REST Countries, etc.) |
| Monthly Quota | 1,000 API calls |
| Rate Limit | 10 requests/minute |
| Support | Community only |
| SLA Target | None |
Suitable for evaluation and proof-of-concept work.
Standard Tier¶
| Setting | Value |
|---|---|
| API Access | Public APIs + OEM connectors + DMS connectors |
| Monthly Quota | 100,000 API calls |
| Rate Limit | 60 requests/minute |
| Support | Business hours |
| SLA Target | 99.5% uptime |
Suitable for production workloads with moderate volume.
Premium Tier¶
| Setting | Value |
|---|---|
| API Access | All connectors (including finance, telematics, logistics) |
| Monthly Quota | 1,000,000 API calls |
| Rate Limit | 300 requests/minute |
| Support | 24/7 with priority response |
| SLA Target | 99.9% uptime |
Suitable for high-volume production workloads with strict SLA requirements.
Viewing Your Product¶
Enterprise Admins can view their assigned gateway products:
- Navigate to SETTINGS > Enterprise Settings
- Scroll to the Subscription section
- Your assigned products are listed with their limits
You cannot change your gateway products -- contact your Platform Admin to upgrade or modify.
Rate Limiting Behaviour¶
When your enterprise hits a rate limit:
- Queued: Requests are queued for a short period (up to 5 seconds)
- Throttled: If the queue fills, requests receive a 429 (Too Many Requests) response
- Retry: DIBOP's retry mechanism automatically backs off and retries throttled requests
- Headers: The response includes standard rate limit headers:
HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1712582400
Retry-After: 15
Rate Limit Scope¶
Rate limits apply at multiple levels:
| Scope | Description |
|---|---|
| Per enterprise | Total requests across all systems and orchestrations |
| Per system | Requests to a specific connected system |
| Per orchestration | Requests from a single orchestration |
The most restrictive limit applies. For example, if the enterprise limit is 300/min and the per-system limit is 60/min, a single system cannot exceed 60/min even if the enterprise-wide limit has capacity.
Custom Products¶
Platform Admins can create custom gateway products for specific enterprise needs:
Creating a Custom Product¶
- Navigate to Platform Config > Gateway Products
- Click Create Product
- Configure:
| Field | Description |
|---|---|
| Name | Product name (e.g., "Automotive Enterprise Plus") |
| Description | What this product includes |
| API Groups | Which API groups are included |
| Monthly Quota | API call limit |
| Rate Limit | Requests per minute |
| Response Filtering | Whether to restrict certain response fields |
- Save the product
Assigning a Product¶
- Navigate to Platform Config > Enterprise Management
- Select the enterprise
- Add the product to their subscription
- Save
Changes take effect immediately.
API Groups¶
APIs in the DIBOP catalogue are organised into groups that can be included or excluded from gateway products:
| Group | APIs Included |
|---|---|
| Public | NHTSA, REST Countries, ExchangeRate, Open-Meteo, HTTPBin |
| OEM | Mercedes-Benz OneAPI, and other OEM-specific connectors |
| DMS | Dealer Management System connectors |
| CRM | Salesforce, HubSpot, and other CRM connectors |
| Finance | Stripe, and other payment/finance connectors |
| Telematics | Vehicle tracking and fleet management connectors |
| Logistics | Shipping and yard management connectors |
Subscription Management¶
Viewing Active Subscriptions (Platform Admin)¶
- Navigate to Platform Config > Gateway Products
- Click on a product to see which enterprises are subscribed
- View usage metrics per enterprise
Usage Reporting¶
Platform Admins can generate usage reports:
- Per-enterprise API call volume
- Per-product utilisation (actual vs quota)
- Overage tracking (enterprises approaching or exceeding limits)
- Revenue allocation (if products have associated billing)
Upgrading or Downgrading¶
Impact of Upgrading¶
When an enterprise is upgraded to a higher product tier:
- New API access is immediately available
- Higher quotas and rate limits take effect immediately
- No disruption to running orchestrations
Impact of Downgrading¶
When an enterprise is downgraded:
- APIs not included in the new tier become unavailable
- Running orchestrations that use those APIs will fail at the next API call step
- Quotas and rate limits are reduced immediately
- Existing data and configurations are preserved
Review Before Downgrading
Before downgrading an enterprise, review their active orchestrations to identify any that use APIs not available in the lower tier. Notify the Enterprise Admin so they can adjust their orchestrations.
Next Steps¶
- Quotas & Rate Limits -- detailed rate limiting behaviour
- Available Connectors -- browse the API catalogue
- Platform vs Tenant Admin -- understand who manages products