All Collections
How To's
Sudo API and Dashboard
How to Create an API Key on Sudo
How to Create an API Key on Sudo

This article provides a step-by-step guide on how to create an API key, which is a crucial security measure for using Sudo services.

H
Written by Hilda
Updated over a week ago

An API key is a unique identifier used by application programming interfaces (APIs) to authenticate and authorize access to Sudo services. It is essentially a secret code that grants permission for a specific service to interact with and access its features or data.

To create an API key, you will need to follow these general steps:

STEP 1: CREATE SUDO ACCOUNT

To create an API Key you must have a business account with Sudo, to do that visit https://app.sudo.africa and click on"Create Account". Read more on how to get started on Sudo

STEP 2: CREATE API KEY

Once your account is fully set up, navigate to "Developer" on the left navigation menu. You will see the list of the API Keys you created in the past on Sudo, click on "Create API Key".

SUDO API KEYS PAGE

After which a modal will show up, and you will need to provide the following:

  1. Name (to easily identify it, in case you have more than one)

  2. Validity period, after which the key will expire and you will be required to create a new one to continue accessing the service. The period ranges from 1 day, 1 week, 1 month, 3 months, 6 months to 1 year. A shorter expiration period provides enhanced security by regularly rotating the keys to ensure unauthorized access is mitigated.

  3. IP address (optional), is a list of trusted IP addresses, usually static ones, it is a security measure that restricts access to a particular network or system only to those IP addresses that have been approved and added to the whitelist. This approach is typically used to protect sensitive information and prevent unauthorized access from unknown or potentially malicious sources.

SUDO API KEY CREATION MODAL

Finally, click on the "Create" button. If the Key is successfully created, a modal will appear.

STEP 3: COPY YOUR API KEY

SUDO API KEY MODAL

NOTE: API keys are typically considered sensitive information that should be kept confidential and not shared with anyone including Sudo staff, and once an API Key is generated, the user is the only one with the key. Sudo does not save the keys on its end, and they cannot be retrieved by a Sudo staff.

In conclusion, API keys play a crucial role in authenticating and authorizing access to Sudo services. It is recommended that you copy immediately when it is created and store it in a safe environment.

Did this answer your question?