You will need to make sure there is a signed API Partnership Agreement in place. The CIC will be able to confirm that the client has signed the agreement. However, this information can also be found in Hubspot in the company’s record.
Simply search for the company and in the right-hand column scroll down to the Panda Doc section – here you will be able to see any signed agreements.
Step 2 – Raise a Service Task
You then need to raise a Service task with the following information:
Hi,
Please activate the API service for (CLIENT NAME) in test and live.
The key contact(s) are: (Include the key contact(s) for this client, this information allows us to liaise with them to provide the Client ID credentials and add them to a contact list for any API updates.)
For the first few clients, David will liaise with the client contacts to provide credentials and will create a Jobtrain Administrator Security role on the account to use as a master user account.
Step 3 - Security Roles
Note for support:
If you ever need to enable API for a client in Security Roles, you can do so by following these steps below:
Go to:
- Settings
- Security Roles
- Select the relevant security role
- Settings
- Enable ‘General Setup:GenerateOpenApiPassword"
This will provide the relevant security role access to generate an API password - details of how to generate a password are included in the API user guide.