Partner Management when using JWT link

Authentication

To use this API, all calls must be authenticated, i.e. a token in the header must be present. The API to do this authentication is found here: ExorLive OAuth 2.0 Authentication.

The methods

  • All calls should have these headers:
    • "ExorLive-Client": "client named to be agreed upon with ExorLive AS."
    • "Authorization": "Bearer accesstoken"

  • The base URL for all these methods is: https://exorlive.com/

RequestAPIAccessForPartnerOrganizationAndGetAdminUserId

The scenario

  • The PartnerA has a software called JournalA. They have 3 customers called Cust1, Cust2, and Cust3.
  • Each customer has their own Organization in ExorLive.
  • PartnerA has created a link between JournalA and ExorLive, so that the users can jump from JournalA to ExorLive. That is implemented using the ExorLive Partner JWT link.
  • PartnerA is using the ExorLive API and has recieved an API key from ExorLive for this.
  • PartnerA would like to call the API and access ExorLive data about Cust1, Cust2 and Cust3.
  • Cust1, Cust2 and Cust3 must approve the access to their ExorLive data. That happens automatically when the first user in each customers organization uses the jump from JournalA to ExorLive.
In the scenario described above, the PartnerA may call this method to get the API access to Cust1 or Cust2 or Cust3's data. An adminUserId of the given organization is returned. Use this to get the accesstoken to call the API for that organization.
NameRequestAPIAccessForPartnerOrganizationAndGetAdminUserId
Urlhttps://exorlive.comosloapi/access/RequestAPIAccessForPartnerOrganizationAndGetAdminUserId
MethodGET
Input
  • partnerApiKey: The ClientKey as provided by ExorLive support (see ExorLive OAuth 2.0 Authentication.).
  • externalOrganizatonId: The Id of the Customer in the partners system. The same ID that is used in the JWT link payload.
Sample calls
  • https://exorlive.com/osloapi/access/RequestAPIAccessForPartnerOrganizationAndGetAdminUserId?partnerApiKey=partnera.com&externalOrganizatonId=custA