Valid Web Service User credentials are required to perform nearly all operations in VeraCore's API.
- VeraCore's web services require valid Web Service User credentials in every request.
- API calls that use a Token also require valid Web Service User credentials to generate the token, good for three months.
Setup Web Service Users in the PMA (Admin) System.
To define a Web Service User:
- In PMA, navigate to Web Service User Set-Up. Click + to add a new one.
- Enter the user’s User Id and Password.
- Specify the system on which the user may run web services. Note: for the public api options, services must be running in the system. Check the Create/Edit Databases menu for this system and ensure that Disable Services is un-checked. Please note that activating services in the system turns on automatic processing in that system.
- Specify which web services the user may run.
If you select Dynamic Reporting API or Expected Arrival API (not shown), you will be prompted to select an Access Type (see second image, below.) This is based on the Menu Access levels associated with the selected system. When Dynamic Reports are published, they can be restricted to users by access type. The Dynamic Reporting API enforces those restrictions by requiring an access type for your web service user.
- Save the new user.
User Id: (required) Enter an ID for this user.
Password: (required) Enter this user’s password.
Re-type Password: (required) re-enter the user’s password.
System: (required) Select one system in which the user may run Web Services.
Access Type: (Required and visible only if DynamicReporting is selected.) When Dynamic Reports are published, they can be restricted to regular users by the user's access type. The Dynamic Reporting API enforces those restrictions by requiring an access type for the web service user.
Public API: Check the boxes beside the applicable API methods. These will be used to login to the API and generate a token, good for three months.
Web Services: (optional) Check the box beside each Web Service to which you want to give the user access. You'll use the credentials created here in every web service request.
