FUSE Health Auth & Key Management API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) Auth & Key Management API
  version: 1.0.0
  description: 'Server-to-server API exposing the FUSE brand-admin surface so a single brand/tenant can build its own admin frontend. Every request is authenticated with an API key bound to exactly one clinic; all data is auto-scoped to that clinic and cannot reach another brand''s data. Isolation is enforced by application-layer clinic filtering on every query.


    COVERAGE: 218 operations across 180 paths, and EVERY ONE is available to every brand. There is no per-clinic enablement step. What governs access: your API key and its scopes, the clinic the key belongs to (every read and write is filtered to it), your plan''s entitlements for the two commercially-gated areas — Affiliates (`AFFILIATES_TIER_REQUIRED`) and CRM Connect (`CRM_TIER_REQUIRED`) — and rate limits.


    AUTH: the external /api/v1 surface uses an API key (`x-api-key`, ApiKeyAuth). Key management (/api-keys) and /auth/signin live at the API root and use a brand-admin JWT (BearerAuth); /auth/signin itself is unauthenticated.


    SCOPES: every key carries scopes; read-only is the default and mutating endpoints require the `write` scope (403 INSUFFICIENT_SCOPE otherwise). Keys default to a 1-year expiry.


    RATE LIMITING: every endpoint may additionally return `429 Too Many Requests` with a `Retry-After` header; 429 is not repeated on each operation below.


    PLATFORM FIELDS: product cost, fees, pharmacy routing, doctor questions and FUSE approvals are set by FUSE, not by the brand. Any write (POST/PUT/PATCH/DELETE) whose JSON body carries one of those fields at any depth — for example `pharmacyPrice`, `shippingFeeUsd`, `coolerFeeUsd`, `pharmacyId`, `preferredPharmacyId`, `pharmacyProvider`, `requiredDoctorQuestions`, `facilitationFee`, `placeholderPrice`, `legalBusinessName`, `isTemplate` or `tenantManagerApproved` — is refused with `403 PLATFORM_FIELD`, whose `fields` array lists the offending paths; remove them and resend. (One exception: `POST /api/v1/products` still accepts the `pharmacyPrice` its schema requires, and ignores it.) 403 PLATFORM_FIELD is not repeated on each operation below.'
servers:
- url: https://api-dev.fusehealth.com
  description: Development
- url: https://api.fusehealth.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Auth & Key Management
  description: Key management uses a brand-admin JWT (from /auth/signin), NOT an API key. Everything else uses x-api-key.
paths:
  /auth/signin:
    servers:
    - url: https://api-dev.fusehealth.com
      description: Development (root — no /api/v1 prefix)
    - url: https://api.fusehealth.com
      description: Production (root — no /api/v1 prefix)
    post:
      tags:
      - Auth & Key Management
      summary: Obtain a brand-admin JWT (to manage keys)
      operationId: postAuthSignin
      description: Obtain a brand-admin JWT (to manage keys).
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                password:
                  type: string
            example:
              email: you@brand.com
              password: '...'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api-keys:
    servers:
    - url: https://api-dev.fusehealth.com
      description: Development (root — no /api/v1 prefix)
    - url: https://api.fusehealth.com
      description: Production (root — no /api/v1 prefix)
    post:
      tags:
      - Auth & Key Management
      summary: Issue a key.
      operationId: postApikeys
      description: Issue a key. Default scope read-only + 1yr expiry; pass scopes:["write"] for full. Raw key returned once.
      security:
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                kind:
                  type: string
                  enum:
                  - secret
                  - publishable
                  default: secret
                  description: '"secret" (default) — server-side management key, governed by scopes. "publishable" — fuse_pk_… key for the browser; may call ONLY POST /api/v1/checkout/sessions (everything else answers 403 KEY_KIND_NOT_ALLOWED). scopes are ignored for a publishable key and forced to read+write so that one route passes requireWrite.

                    '
                scopes:
                  type: array
                  items:
                    type: string
                    enum:
                    - read
                    - write
                expiresAt:
                  type:
                  - string
                  - 'null'
                  format: date-time
                  description: Omit for the 1-year default; null opts out of expiry; a past date is 400.
            example:
              name: My integration
              kind: secret
              scopes:
              - read
      responses:
        '201':
          description: Success — data.apiKey is the raw key, returned exactly once; data.kind echoes the key type.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    get:
      tags:
      - Auth & Key Management
      summary: List this clinic's keys (metadata only — no secret)
      operationId: getApikeys
      description: List this clinic's keys (metadata only — no secret).
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api-keys/{id}:
    servers:
    - url: https://api-dev.fusehealth.com
      description: Development (root — no /api/v1 prefix)
    - url: https://api.fusehealth.com
      description: Production (root — no /api/v1 prefix)
    delete:
      tags:
      - Auth & Key Management
      summary: Revoke a key (immediate)
      operationId: deleteApikeysById
      description: Revoke a key (immediate).
      security:
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/me:
    get:
      tags:
      - Auth & Key Management
      summary: 'Identify the key: clinic, name, scopes. Smoke-test connectivity'
      operationId: getApiV1Me
      description: 'Identify the key: clinic, name, scopes. Smoke-test connectivity.'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Forbidden:
      description: Authenticated but not permitted (insufficient scope, wrong role, or FUSE feature not enabled)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, invalid, inactive, or expired API key (or JWT)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found (or not owned by the key's clinic)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      description: 'Failure shape. NOTE: most modules use `message`; programs endpoints use `error`. Read both. Some errors include a machine-readable `code` and/or a `data` payload.'
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        message:
          type: string
        error:
          type: string
        code:
          type: string
        data: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Clinic-scoped API key. Keep server-side; never expose in a browser or app bundle.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: FUSE brand-admin JWT (from POST /auth/signin). Used ONLY by the key-management endpoints — the external /api/v1 surface never accepts JWTs, and API keys never work on key management.