API REFERENCE

View as Markdown

Stable

Authentication API

Sign in with the credentials PPS issues you, and exchange a refresh token for a new access token. Every other PPS API call carries the access token in an Authorization: Bearer <token> header.

An access token expires one hour after it is issued, and the refresh token expires on its own schedule. An unattended integration must be able to sign in again on its own, not just refresh.

Obtaining An Access Token walks through signing in, refreshing, and what to do when a refresh is rejected.

Operation Method and path Reference
Sign In With Password POST /user-management-services-ws/oauth2/002/signInWithPassword Sign In With Password
Refresh Access Token POST /user-management-services-ws/oauth2/002/refreshIdToken Refresh Access Token

These two paths sit under the user management service rather than the base URL the other APIs share, so send them to the host exactly as written above.


Table of contents


Copyright © Pitchpoint Solutions. All rights reserved.