Reseller Portal API

To grant a Reseller access to a portal, the Integrator uses the Reseller Portals API to retrieve a special Portal Access URL. The integrator can then either redirect the end-user to the Portal Access URL or render a page that contains an iframe pointing to Portal Access URL. Please see the Embedding section for more information about using iframes.

Under no circumstances is the Integrator's platform permitted to fetch the contents of the Portal Access URL. The Portal Access URLs may only be accessed by the end-user's browser.

The URL obtained by the API has a few important characteristics:

it is one time use
it expires in 60 seconds
it is unique to the reseller and the portal they wish to enter and cannot be manipulated by the end-user
it is self-authenticated meaning the end-user’s browser does not need API keys to follow it

A request for a portal contains at the very least reseller_id and portal attributes but it may contain more based on the portal being requested. See below:

reseller_id integer, required	The Reseller we are launching the portal for.
portal string, required	Currently, the only accepted value is `history`
user_id integer, required, history portal only	For the History Portal only. Indicates whose history you want to view.

POST

/api/v1/portals/history

Creates a special Portal Access URL for the user indicated and returns the URL.

Example History Portal Request

{
  "reseller_id": 1,
  "user_id": 1
}

Example Response

{
  "url": "https://creditconnect.instascreen.net/portal/abc123..."
}