Authentication

Secure embed view

Exchange an order detail view URL for a short-lived secure URL with an endpoint-restricted access token appended. The order must exist and have an associated device. This endpoint is not a general-purpose exchange for arbitrary dashboard or list-view URLs. Authenticate with HTTP Basic auth using your account ID and secret key. Use the returned secure_embed_url as the iframe source without changing its query parameters.

post/oauth/embed-token

Request

Base URL
https://v3.api.hypertrack.com
Auth
none declared
TypeScript
https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/oauth/embed-token/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

embed_urlstring required

Order detail URL with a path containing /orders/{order_handle}. The fulfillment_attempt query parameter defaults to 0. Use show-visits-only=true for visit-only visibility.

grant_type'client_credentials' required

Must be client_credentials.

Example request

{
  "embed_url": "https://embed.hypertrack.com/orders/my_order_handle?fulfillment_attempt=0&show-visits-only=true"
}

Response

Secure embed URL issued.

access_tokenstring

Endpoint-restricted OAuth access token for the order view.

token_typestring

expires_ininteger

Token lifetime in seconds.

embed_urlstring

Original URL to be embedded.

secure_embed_urlstring

Secure URL with the token appended for embedding.

Example response

{
  "token_type": "Bearer"
}

Changes

No recorded changes to this operation across all 1 revision of this API.