Requirements
Authentication
The following information is required to access the Wise Rest API:
|
ApplicationName |
Name of application |
|
API-ID |
ID of application |
|
API-KEY |
Key of application to calculate the Wise-key |
The above information is published by OCLC. With the help of this data, a so-called WISE-KEY must be calculated. This WISE-KEY must be included with every request and is provided in ‘WISE_KEY’ (underscore).
The API-ID is linked to the ApplicationName, and is the same on all environments and Wise installations. The API-KEY is unique per Wise system, and differs between PROD and all TEST/ACCEPT environments.
For the endpoints in the shared domain, it is also necessary to log in with a username / password combination. This login generates an authentication token. This token is also sent with the requests.
Permissions
To use the API, it is sometimes necessary to create a user with specific permissions (see above). This user can be created in the Manager just like the normal Client login. Most permissions are mentioned in the documentation with the used endpoint.
The below information contains the collected information for some specific apps:
| Application | Permission |
|---|---|
| ActivityShop | ACTOREN READ on organization (instantie) level |
| BiebAppProxy | Proxy authentication user needs to be created and IP of the proxy-server needs to be whitelisted |
| Hoppinger | ACTOREN READ on organization (instantie) level |
| LVPTickets | ACTOREN READ on organization (instantie) level |
| NBDBookarang | TITELONDERHOUD READ on organization (instantie) level |
| NBDStreamingBuzz | Credentials of the patron are used, no specific actor with role is needed |
| Orders* | The actor that is used needs to be present in ROL_SUPPLIER, see Acquisitions |