Athena — developer-portal/README.md

developer-portal — Public API Hub for the Mahmoud Consultancy Portfolio

Domain: developer.glorylabs.nl Repo: mahmoudholding/developer-portal Status: vision captured 2026-05-27; branding decision PENDING; implementation issues filed under label devportal-vision.


Vision

The developer portal is the single public developer hub for every product in the Mahmoud Consultancy B.V. portfolio. External integrators and internal engineers come here to:

  • Read API documentation (Redoc-style) for any active product.
  • Sign in, get an account, and issue API keys per product.
  • Try endpoints live where feasible (sandbox / try-it-out).
  • See changelog, status, and migration guides.

Every product in this workspace is a merknaam (brand) of Mahmoud Consultancy B.V. The portal surfaces those products as clearly-named sections; legal/controller designation always names Mahmoud Consultancy B.V.

Audience

  • Primary: external developers integrating with our product APIs (partners, customer engineering teams).
  • Secondary: internal engineers across GloryLabs working across products who need one consistent reference.

Scope — products covered

All active product OpenAPI specs across the portfolio:

| Product | Repo | Notes | |---|---|---| | auditPic | mahmoudholding/auditPic | signed-photo SaaS | | claimio | mahmoudholding/claimio | schadeformulier B2B | | europeLogin | mahmoudholding/europeLogin | e-Herkenning alternative | | mahmoud-consultancy (InterimPlaza) | theroomyapp/mahmoud-consultancy | recruitment platform | | valideerleeftijd | mahmoudholding/valideerleeftijd | PSD2 age verification |

Excluded: roomy-mobile (separate sub Roomy B.V., not part of the MC portfolio).

Public access model

  • Docs pages are PUBLIC — no auth wall to read API references, schemas, examples.
  • Account + API key issuance requires sign-in.
  • Sandbox/try-it-out may require a sandbox key (issued on sign-in) to prevent abuse, but the docs themselves stay open.

Key issuance

  • Per-product keys (a developer signed in to the portal can mint a key scoped to a specific product).
  • Keys stored portal-side; each product backend validates incoming keys via shared middleware (one issue per product repo — see umbrella).
  • Rotation, revocation, and per-key rate limits are in scope; quotas TBD per product.

Branding decision — OPEN

Working recommendation (from orchestrator): GloryLabs umbrella as the dev-agency-facing brand, with each product clearly named in its own section, and legal fine-print naming Mahmoud Consultancy B.V. as controller / contract party.

Three options on the table for owner sign-off:

  • (a) GloryLabs umbrella + product sections (recommended).
  • (b) Mahmoud Consultancy umbrella directly.
  • (c) Neutral "Developer Portal" brand, products named only in sections.

Tracked in issue (j) under the umbrella.

Spec pipeline

Each product publishes its OpenAPI spec from its own CI; the portal ingests on release. Mechanism (pull vs push, CDN vs git submodule vs artifact) tracked in issue (e).

Try-it-out

Redoc is read-only. Options under evaluation:

  • Swagger UI — battle-tested, mutable, but visually a step down.
  • Stoplight Elements — closer to Redoc aesthetics, supports try-it.
  • Hybrid — Redoc for read, embedded Swagger UI per endpoint for execute.

Decision tracked in issue (f).

Legal

Terms of Service, Privacy Policy, and DPA must name Mahmoud Consultancy B.V. as the GDPR controller. Per-product processing addenda may layer on top. Tracked in issue (i).

Sandbox / staging

Each product exposes a staging environment that the portal can route developers to. Setup tracked in issue (g).

Related

  • Workspace-level CLAUDE.md — corporate structure, port registry, ingress hostnames.
  • Issues: https://github.com/mahmoudholding/developer-portal/issues?q=label%3Adevportal-vision

Reacties

Nog geen reacties