Creating API credentials for integration

The client_id and client_secret are unique and can be created by selecting the "+ New Credentials" button on the API Credentials tab on the Integrations screen.

      Navigate > Configuration > Basic Settings > General Company > Integrations > API Credentials 

      

If the integration design requires the ability to create or update data on the system, then the credentials being created need to be linked to a user profile and “Full Access” needs to be selected for the Scope. This is to identify any changes made to data on the system by a systems integration in the audit trail on a screen.

      

Access permissions are provided by linking the selected user profile to a security role. This will enforce these permissions for API access. For example, if the API should not be able to access any payslip data (from a read or write perspective), then you can create a security role that denies access to payslips and attach the relevant user profile to this role and then select this user name in the User drop down list on this screen.

      Navigate > Configuration > Security > Security > Security Roles > Add/Edit/View Permissions

      

      

On the test environment, this screen will have an additional checkbox with label of “Development Mode” that will return “masked” figures on all payslips (except the pdf payslips), as well figures on the pay rate screen. This option can be used for developers who are designing the integration, to ensure that they are not able to access any sensitive data.

Important! The API client_id and secret will be displayed after saving and must be copied and saved immediately as you will not be able to retrieve this client id and secret once you navigate away from this page.

       

If you require API credentials for the test environment, the same process must be followed on the test environment by logging into test.payspace.com. These credentials will not be overwritten by the weekly refresh from the production environment.

• Related Articles

• Where can I find the Company ID?

  The Company ID can be found on the General Details tab on the Basic Company Information screen. Navigate > Configuration > Basic Settings > Company Settings > Basic Company Information > Company Did You Know? The company ID is used during the API ...

• How do I activate Single Sign-On integration?

  Single Sign On is a principle that allows users to log into multiple unrelated websites without having to have a separate username and password for each. Integration between PaySpace and the company’s Identity Management solution (such as Active ...

• Basic Company Information | The Basic Company Information Screen

  Overview The Basic Company Information screen stores the company’s biographical information and consist of the below tabs: Company Statutory Fields Company Address Company Themes General Contact Employer Payment Summary (EPS) Details The seven tabs ...

• Basic Company Information | Grouping Companies

  Overview When a new company is created, the system automatically generates a company group (i.e., a parent container) in the backend. The name of the group that a company belongs to will be displayed under the "Group Action" section above the ...

• Where are company documents added?

  Company Documents have to be added on the Company Documents screen before employees can be granted access to view them on ESS. Navigate > Configuration > Basic Settings > General Company > Company Documents Related FAQ How do I grant employees access ...