Skip to Content

Blue API Gateway

by
Odoo
v 19.0 Third Party 1
Download for v 19.0 Deploy on Odoo.sh
You bought this module and need support? Click here!

Metered API access in Odoo 19

Blue API Gateway

A thin Odoo control plane for authenticated, entitled and financially settled API execution using Unkey, Blue Usage Wallet and OpenMeter integrations.

Overview

Blue API Gateway exposes an Odoo-managed POST endpoint for allowlisted API handlers. Each request is verified against an external API key reference, matched to a company policy and customer entitlement, checked against rate limits and settled through the usage wallet.

This module is an access, entitlement and settlement control plane. It is not a web application firewall, infrastructure proxy or replacement for an external API management platform.

Benefits

Commercial control in Odoo

Manage policies, customer entitlements, unit prices and wallet settlement from the same business system.

Idempotent execution

Replay the same external request safely without charging the customer twice.

Bounded data retention

Store only a payload fingerprint and retain response JSON for a configurable period of up to 168 hours.

Reconciliation evidence

Link request records to reservation, capture or release entries and preserve settlement-error states for investigation.

Features

Bearer key verification → registered external key reference → policy and environment validation → customer entitlement → per-key policy rate limit → wallet reservation → allowlisted handler execution → wallet capture or release → metering event from the settled wallet entry

Policy-based routing

  • Unique policy codes per company
  • Staging and production environments
  • Allowlisted handler registry
  • Optional Unkey API scope

Entitlements

  • Customer and policy relationship
  • Optional validity windows
  • Multi-company isolation
  • Denial before wallet charging

Financial settlement

  • Configurable unit price per policy
  • Reserve before provider execution
  • Capture on success
  • Release on failure or rejection

Request ledger

  • Payload SHA-256 fingerprint
  • Correlation and request identifiers
  • Replay counter
  • Immutable settled records

Screenshots

The final listing package must include reviewed screenshots from a sanitized staging database. Screenshots must not expose API keys, customer identifiers, request payloads, provider responses, wallet balances or production policy codes.

Compatibility

  • Odoo 19 runtime
  • Blue Usage Wallet for reservation, capture and release
  • Blue Unkey Bridge for external key verification and rate limits
  • Blue OpenMeter Bridge for settled usage analytics
  • Optional allowlisted handler modules such as the Blue Credit Query Gateway adapter

Installation

  1. Install the gateway and its wallet, Unkey and OpenMeter bridge dependencies in Odoo 19.
  2. Configure external credentials through environment variables and validate the bridge settings.
  3. Enable the gateway in staging and keep the configured environment set to staging.
  4. Create a policy, validate its allowlisted handler and grant a customer entitlement.
  5. Run idempotency, insufficient-balance, rate-limit and provider-failure tests before any production promotion.

Support

The proposed support scope covers module installation, policy and entitlement configuration guidance, supported bridge integration troubleshooting and correction of defects in the packaged module behavior. External provider availability, key issuance policy, infrastructure security, custom handler development and customer data remediation remain outside the default scope unless contracted separately.

FAQ

Does the gateway store plaintext API keys?
No. The key is used ephemerally for external verification, while Odoo stores the external key reference.
Does it store request payloads?
No. The request ledger stores a SHA-256 fingerprint, not the original request payload.
Can the same idempotency key charge twice?
No. A matching replay returns the existing request result, while a different payload produces an idempotency conflict.
What happens when provider execution fails?
The wallet reservation is released. When provider execution succeeds but capture fails, the request enters a settlement-error state for reconciliation.
Is production enabled automatically?
No. The gateway is disabled by default and production requires explicit settings and matching policy environment.
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Community Apps Dependencies
Lines of code 2399
Technical Name blue_api_gateway
LicenseLGPL-3
Websitehttps://conexaoazul.com

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author, please use the developer contact information. They can usually be found in the description.