Primo API Docs

__METHOD= GET . __PATH= /primo/v1/jwt/{institution} .

Guest JWT creater

This service returns a guest JWT indicator, which is used to manage the session and protect the required for on-premises customers. The guest JWT is required for non-hosted customers only.

For example, the JWT will appear as follows when added to the header in the API request:
key=Authorization, value = Bearer eyJraWQiOiJwcmltb0V4cGxvcmVQcml2YXRlS2V5LTAxQkNfSU5TVCIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJQcmltbyIsImp0aSI6IiIsImV4cCI6MTUxMjk5MDAyOSwiaWF0IjoxNTEyOTAzNjI5LCJ1c2VyIjoiYW5vbnltb3VzLTEyMTBfMTEwMDI5IiwidXNlck5hbWUiOm51bGwsInVzZXJHcm91cCI6IkdVRVNUIiwiYm9yR3JvdXBJZCI6bnVsbCwidWJpZCI6bnVsbCwiaW5zdGl0dXRpb24iOiIwMUJDX0lOU1QiLCJ2aWV3SW5zdGl0dXRpb25Db2RlIjoiMDFCQ19JTlNUIiwiaXAiOiIxMC4xLjExNi4yMzQiLCJvbkNhbXB1cyI6ImZhbHNlIiwibGFuZ3VhZ2UiOiJlbl9VUyIsImF1dGhlbnRpY2F0aW9uUHJvZmlsZSI6IiIsInZpZXdJZCI6IkJDX1ZJRVciLCJpbHNBcGlJZCI6bnVsbCwic2FtbFNlc3Npb25JbmRleCI6IiJ9.6IdBSkWQfgV79Vx9nOeBQCcO4W9-_pxEOPiQDvHn3aJVKQ-uDIkI1O5ZLo2xdFtlRW0UxINqh5bJ2yjUCX0zGg


Basic URL example for hosted customers:
<api-gateway-url>/primo/v1/jwt/<institution_code>?lang=en_US&vid=<view_code>&apikey=<apikey>


Basic URL example for on-premises customers:
<base-local-url>/primo_library/libweb/webservices/rest/v1/guestJwt/<institution_code>?lang=en_US&vid=<view_code>

Resource URL

GET /primo/v1/jwt/{institution}

API Description

URL Parameters

ParameterTypeDescription
institutionxs:stringThe institution. Example: /v1/guestJwt/VOLCANO.

Querystring Parameters

ParameterTypeRequiredDescription
vidxs:stringRequiredThe view id.
Example: vid=Auto1.
langxs:stringRequiredThe language.
Example: lang=en_US.

Body Parameters

None

Output

Possible Error Codes

CodeMessage