Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface CreatePhysicianSessionResponse

    POST /v1/physicians/{id}/session response — a physician session token and everything a browser client needs to use it. Hand the whole object to connectPhysician from @natzar/client/physician and it is self-configuring.

    interface CreatePhysicianSessionResponse {
        sessionToken: string;
        expiresAt: string;
        apiUrl: string;
        physician: PhysicianResource;
    }
    Index
    sessionToken expiresAt apiUrl physician
    sessionToken: string

    The session token: send it as Authorization: Bearer <sessionToken> on the physician-side routes. Browser-safe — it names one physician, expires, and can do nothing your key could not have let that physician do.

    expiresAt: string

    When the token expires; re-mint before then (2 minutes early is plenty).

    apiUrl: string

    The base URL of THIS API (through /v1, no trailing slash) as seen from the request — returned per mint, like the embed mints return their transport, so a browser bundle never bakes in a host that may move.

    physician: PhysicianResource

    The physician the session was minted for.

    Settings
    Member Visibility

    On This Page
    Properties