Nest Engineering Docs
Partner Credentials

Interfaces

Inbound and outbound contracts for Partner Credentials

Authentication

  • Internal ingress only. Cloud Run IAM controls access.
  • No API key or user-facing auth middleware.

Base path

  • v1: /api/v1

Endpoint catalog

ResourceOperationsNotes
/healthGETHealth check
/auth/pims/tokenGETIssue partner credentials

Request expectations

  • oid (organization id) is required.
  • mode is required for Bitwerx (batch or ondemand).
  • Organization metadata must exist in Spanner.
  • ezyVet password auth requires ezvet_base_url on the org record.

Response model

NestAuthResponse contains:

  • provider, provider_number, auth_type
  • OAuth fields: access_token, token_type, expires_at
  • API key field: api_key (HAP)
  • Bitwerx fields: practice_id, mode

Outbound dependencies

  • Cloud Spanner Organizations table.
  • Secret Manager for partner credentials.
  • Partner token endpoints (ezyVet, Bitwerx, HAP). Data APIs are used by Handler.

Last updated on