Provides short-lived tokens and browser redirect flows for app data exchange.
Show the data exchange approval page.
Returns the data exchange approval page for a short-lived token. The page renders in a browser. First, the app must create a token with POST /data-exchange/token. Then the app opens this URL in the browser of the user, with the token and app context. On the page, the user reviews the requested permissions. Then the user approves or cancels the exchange.
Approval is a one-time experience. If the user approved these permissions in an earlier exchange, this request does not render the page. The system consumes the token and redirects to the app callback with data_exchange_status=granted. This completes the exchange. The app must accept a granted callback from this URL without a second form submit.
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. Redirects the browser to the configured callback URL of the app. When the user approves, the callback receives data_exchange_status=granted and granted_permissions. When the user cancels on the approval page, the callback receives data_exchange_status=cancelled, denied_permissions, and error=access_denied. After a recoverable error, if the system knows a safe callback, it redirects 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 token. The app passes the token to the /data-exchange browser flow as a query parameter. Send requested_permissions in the request body. It declares which permissions the user must review during the browser flow.
Tokens expire after five minutes. Each token is single-use. The system consumes a token when the user submits the form. The system also consumes a token when GET /data-exchange skips the approval page, because the user already approved the requested permissions. Create a new token for each exchange.
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
requested_permissionsData exchange permissions the user should review in the browser flow.
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.