Interchange UI
Interchange UI is a simple user interface built on top of our INTERCHANGE-US API.
You can play with the demo right here. All sandbox test credentials would work.
Steps to deploying Interchange UI are the following
1. Issue Public Key
At your backend, where you have stored client_id and client_secret securely, issue a public key with scope CLIENT|CONTROLS.
2. Issue OAuth Key
Issue an OAuth Key for the user, with scopes USER|GET, NODES|GET, NODES|POST, NODE|PATCH.
3. Test the UI
Next step is to go to the Interchange UI and see if everything is rendering appropriately.
Link (for sandbox): https://uat-uiaas.synapsefi.com/interchange
Link (for production): https://uiaas.synapsefi.com/interchange
GET Params needed in the URL
| GET Param | Note |
|---|---|
| oauth_key | OAuth key of the user who needs to link new accounts |
| public_key | Your public key |
So the final URL would look something like this:
https://uat-uiaas.synapsefi.com/interchange?oauth_key=oauth_key&public_key=public_key.
Android webviews
If you are rendering this component inside an Android webview, please make sure that you have DOM storage enabled
settings.setDomStorageEnabled(true);
GET Params on redirect
GET Params returned on success_uri:
| GET Param | Note |
|---|---|
| user_id | Synapse ID of the user |
GET Params returned on failure_uri:
| GET Param | Note |
|---|---|
| error_code | Error code from Errors Section |
| http_code | HTTP code from Errors Section |
| message | Reason for failure |
| user_id | Synapse ID of the user |
Customizing the UI
You can customize the following things on the UI
| Field | Comment |
|---|---|
| Color Palette | You can update the color with any hex value. By default it uses our colors |
| Logo | Any landscape logo (recommended: 1388 × 367 pixels). By default it uses our logo |
| Success URI | Once login is successful where should we redirect the user |
| Failure URI | If login fails or user wants to abandon the login, where should we redirect the user |
If you wish to change any of these fields, please go to Client Manager on the dashboard to do so. (FAQ on how to get to the Client Manager).
Updated almost 5 years ago