Partner runbook

Integration guide

From partner application to production calls on api.parkerapex.com — one path, one host, one environment header.

Docs hubOpenAPI specsCredentialsPlayground

First call

FHIR R4 CapabilityStatement

Copy this curl against your selected sandbox (NXS-PROD-002), or open the same request in Playground. Replace the token after you create credentials.

curl -sS https://api.parkerapex.com/fhir/R4/metadata \
  -H "Authorization: Bearer $APEX_TOKEN" \
  -H "Accept: application/fhir+json" \
  -H "X-Apex-Environment: NXS-PROD-002"
Open in Playground
  1. 1

    Apply for partner access

    Submit organization details, NPI, address, and accept MNDA/BAA. Applications route to Plexus IAM for GPID assignment.

    Request access
  2. 2

    Sign in after approval

    Use your approved username/password against Plexus IAM. Client credentials are issued after onboarding — not at first login.

    Sign in
  3. 3

    Create credentials

    Issue scoped API tokens or register OAuth 2.0 / SMART clients for your integration.

    Manage tokens
  4. 4

    Review OpenAPI contracts

    Published specs target https://api.parkerapex.com and are scoped to your partner grants. Use Swagger Try-it-out with a Bearer token.

    Open Swagger
  5. 5

    Read FHIR R4 + Kill the Clipboard guides

    Short partner docs cover CapabilityStatement auth headers and CMS Kill the Clipboard (Nexus QR scan + ingest/SMART APIs).

    FHIR R4 guide
  6. 6

    Integrate Kill the Clipboard (Ingest / SMART)

    For CMS Kill the Clipboard and SMART Health Cards/Links, use the Beacon Ingest & SMART OpenAPI contract. Nexus EHR scans patient QR codes natively at check-in; partners call the ingest/verification APIs.

    Partner KTC guide
  7. 7

    Call APIs with your environment

    Use api.parkerapex.com and send X-Apex-Environment (default sandbox: NXS-PROD-002). Most partner routes require Authorization: Bearer <token>.

    Open Playground

Authentication

  • Partner portal session: cookie apex_cc_session after Plexus login
  • API calls: Authorization: Bearer <access_token>
  • Tenancy: X-Apex-Environment header from the environment switcher
  • Partner Number / GPID: PN-XXXXXXXX / APX-XXXXXXXX on every submission

Canonical hosts

API
https://api.parkerapex.com
Portal
https://developers.parkerapex.com
Health
GET /api/health

401/403/405 = protected and alive, not an outage.