Overview
For extracting data (for example, skills) from your resources or importing data (for example, user accounts) to the smartApps to synchronize them with your systems, etc., make use of RESTful APIs. While interacting with a system to retrieve information or perform a function, an API helps you communicate what you want to our system so it can understand and fulfill the request.
It is a way for your organization to share resources and information while we maintain security, control, and authentication, and thus, determine what we can get access to.
Add API key
Use the API key tab of the Setup area in Ludi Cloud to add a new API key as well as manage the existing ones. To start adding an API key, follow the steps listed below:
1. On the navigation menu, click Setup, and then click API key.
2. On the API key page that opens, click +Add API key.
3. Under Information, define an API key name. An API key is generated automatically.
The API key is a unique identifier. It authenticates requests that are associated with your tools for the following purposes:
- Upload data
- Extract skills
- Standardize jobs
4. Under Restrictions, define IP addresses to accept requests from the ones that you supply. It allows you to ensure that only authorized requests are made with your API key.
Whitelisting IP addresses is required to secure an API and get access to it. At least one IP address must be added to the Restrictions list before saving. If no IP address is added, it is not possible to save the API key configuration.
5. Under Available APIs, select API endpoints to indicate how to access your resource.
As a result, the chosen endpoint is appended to the base URL to make a request and retrieve a specific set of data.
For more details about the API endpoints, see Available APIs.
If you select either the Skill extraction or Job standardization endpoint, you have to select a library for each of them. To this end, click a gear icon within the API record, and then select one or more libraries in the dialog that appears.
If no library is selected for any of these endpoints, you cannot save changes. The Save button stays disabled.
6. Once you are done, click Save.
Manage API key
Once you add an API key, its entry is listed on the API keys page.
You can copy an API key you have previously added. To this end, click the 
icon within the API key entry.
To edit an API key, click the three dots button within that connection entry, and then click Edit. Afterward, manage the settings as needed.
To delete an API key, click the three dots button within that API key entry, and then click Delete. You can also delete an API key on the API key edit page. To this end, first, click the three dots button, and then click Delete.
Next step
Well done! Learn more about import pipelines and continuous synchronization.
