Provides short-lived tokens and browser redirect flows for app data exchange.
Show the data exchange approval page.
Returns the browser-rendered data exchange approval page for a short-lived token. The app
should first create a token with POST /data-exchange/token, then open this URL in the
user's browser with the token and app context. The page lets the user review the requested
permissions before approving or cancelling the exchange.
query Parameters
tokenShort-lived data exchange token created by POST /data-exchange/token.
x-yvp-app-keyPublic app key used to resolve the app for direct browser flows.
x-yvp-app-idApp identifier used when a public app key is not supplied.
Show the data exchange approval page. › Responses
Data exchange approval page rendered as HTML.
Complete the data exchange approval flow.
Completes the browser approval flow and redirects the browser to the app's configured
callback URL. When approval succeeds, the callback receives
data_exchange_status=granted and granted_permissions. When the user cancels from the
approval page, the callback receives data_exchange_status=cancelled,
denied_permissions, and error=access_denied. Recoverable errors after a safe callback
is known redirect with data_exchange_status=error, error, and error_description.
query Parameters
tokenShort-lived data exchange token created by POST /data-exchange/token.
x-yvp-app-keyPublic app key used to resolve the app when a token is not supplied.
x-yvp-app-idApp identifier used when a public app key is not supplied.
Headers
AuthorizationBearer access token used only by clients that complete the flow without a token.
Complete the data exchange approval flow. › Responses
Redirects to the app callback URL with the data exchange result.
Create a data exchange token.
Creates a short-lived, highlights-scoped token that can be passed to the /data-exchange browser flow as a query parameter. Tokens expire after five minutes and are consumed when the form is submitted.
query Parameters
x-yvp-app-keyPublic app key used to resolve the app for direct browser flows.
x-yvp-app-idApp identifier used when a public app key is not supplied.
Headers
AuthorizationBearer access token for the authenticated user.
Create a data exchange token. › Request Body
permissionsData exchange permissions for this token.
Create a data exchange token. › Responses
Data exchange token created.
tokenOpaque single-use token for the data exchange flow. Returned only once.
token_typeexpires_inToken lifetime in seconds.