Proplix Secure API Gateway · Version 1.0.0

Master-token and short-lived client sessions

Exchange a private master token for a signed client session and validate TTL, identity, IP and rate limits.

14 code-backed guidesExact navigationInterlinked workflows

Guides in this workflow

Follow the guide that matches the exact action, filter, menu change or issue.

Understand the two-step portal flow

First create a client session with the private bearer token and contact_id, then call /me with the short-lived session token.

Valid active master portal token

Call the session endpoint

POST /proplix_api_gateway/portal_api/session from the external backend.

Valid active master portal token

Use POST for session creation

Other methods return 405.

Valid active master portal token

Send the master bearer token

Use Authorization: Bearer {one-time token}.

Valid active master portal token

Send contact_id

Identify an active CRM contact; the gateway resolves its customer account.

Valid active master portal token

Set optional expires_in

Default 600 seconds; minimum 60 and maximum 900 seconds.

Valid active master portal token

Understand session identity

The signed payload contains client ID, contact ID, profile/audience context, nonce and issued/expiry timestamps.

Valid active master portal token

Understand signed session tokens

The production model signs the session and rejects invalid signatures/payloads.

Valid active master portal token

Read session response

Use success, session token, expires_in and expires_at values.

Valid active master portal token

Resolve invalid master token

Check exact bearer token, active profile and one-way hash match.

Valid active master portal token

Resolve server IP rejection

Call from an allowed IP or update the profile whitelist.

Valid active master portal token

Resolve session rate limiting

Wait for the minute window or adjust the administrator rate limit within 10–1000.

Valid active master portal token

Resolve invalid contact

Use an active contact with a valid linked customer.

Valid active master portal token

Resolve expired client session

Create a new session; sessions are deliberately short-lived and not refreshed by /me.

Valid active master portal token