What is an API Key?

An API key is a unique encrypted string used to identify the application that makes an API call. This key acts as a password to your APIs. You must include this API Key for authentication while executing an API command.
The authentication works like this - During runtime, the Kaleyra.io application will verify the API key and allows the request if the Key is valid. Otherwise, you will get an error as a response to the request.

Generating an API Key and Security Identifier (SID)

1. Sign in to your Kaleyra.io account.
2. Go to Developers and click Generate API Key.

The Create an API Key appears.

3. In the Name field, enter the name you want for API key,
4. In the Whitelisted IP Addresses field, enter the IP addresses you want to whitelist. To add multiple IP addresses, separate them with a (,) comma.

📘

Note:

IP whitelisting is restricted to the execution of the APIs to specific IP addresses.

5. Click Save.

The API key is created successfully. You can see the details along with an auto-generated Security Identifier (SID) and API Key. You must pass this SID and API Key while executing the APIs.

📘

Note:

It is recommended to download and store the key securely. It’s a one-time download process.

6. Click Download to download the details.

📘

Note:

The downloaded file will be in a .xls format and contains all the details that are displayed. Keep this file safe to avoid unauthorized access to the APIs.