API Credentials

Josys offers a set of APIs that allow you to effectively manage your user profiles and devices on the platform. To learn more about the APIs available and how can you use them, please refer to our API Reference Guide. This article will guide you on how to create and manage API Credentials and consume these APIs.

Steps to Manage API Credentials

Step 1: Log in to Josys using your admin credentials.

Step 2: Navigate to the Developers menu and select API Credentials.

Step 3: Click Create to create new API Credentials that you can use during integration.

Step 4: Enter a name for identification of the API Credentials and click Create.

Step 5: Click Copy to copy the API User Key and API User Secret for later use in the integration steps. Click Ok to close the screen. 

Note: 
1. Please note that these API User Secret will be lost permanently once this window is closed. Ensure to keep the API User Secret securely for future API access.
2. The permissions associated with the created API credentials are determined by the user's permissions on the platform. Users can view their permissions by navigating to Settings > Permissions.
3. Super Admin or a Devices/Editor (with data export) role is required to call Device-related APIs.
4. Super Admin or a User/Editor (with data export) role is required to call User profile, Department, and Work Location-related APIs.

Step 6: Click Edit to modify the integration name and Delete to remove these API credentials from the portal.