---
description: >-
  Learn the straightforward steps to create your own set in Gallabox, ensuring
  secure and effective integration.
---

# API Key and Secret

## **Overview**

We'll explore the essentials of API Key and API Secret in Gallabox, detailing their functions and how they synergize.

Prefer watching than reading? Watch the video below:

{% embed url="https://youtu.be/FBWwPHHyg90" %}

Read the guide below:&#x20;

### What is an API Key?

An API key is a unique identifier that grants access to specific functionalities or services offered through its API. Think of it as a digital passkey, enabling developers to unlock the doors to Gallabox's API and integrate its services into their applications securely.

### Understanding API Secrets

An API secret is another form of authentication, but unlike an API key, it is typically kept confidential and known only to the application and the service provider. They function as secret credentials, ensuring the identity verification of the application when interacting with Gallabox's API.

### How They Work Together?

API keys and secrets work hand in hand to authenticate and authorize access to Gallabox's API. Here's how they collaborate:

1. **Access Acquisition**: Create both an API key and secret in your Gallabox account.
2. **Authentication Protocol**: When the third party application communicates with Gallabox's API, it presents the API key in its requests, identifying itself. Gallabox then verifies this key to authenticate the application.
3. **Secured Communication**: Alongside the API key, the application includes the API secret, ensuring secure transmission. Gallabox utilizes this secret to authenticate the application, ensuring that only authorized parties can access the API.
4. **Authorization Verification**: Gallabox checks if the API key and secret combination has the necessary permissions to execute the requested actions. If authorized, Gallabox's API responds accordingly, allowing the application to utilize the desired functionality.

## Video Guide

{% embed url="https://youtu.be/vQe5tNnsG6g" %}

## Create an API Key in Gallabox

### Add New Under API Keys

Go to **Settings** in the navigation panel and select **API keys**. Click on **+ Add new**.

<figure><img src="https://3137140735-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZcl3T6ePz95GpzjAeOLW%2Fuploads%2FsNDDtZI0cKE0XWFaeh9h%2FAdd%20API%20Key.gif?alt=media&#x26;token=b8f26907-4d62-41bd-9fec-ab7dfc942cf1" alt=""><figcaption></figcaption></figure>

### Naming and providing permission

Provide a name to the **API** and select the permissions (All, Restricted, or Read only) for the API. Click on **Add API Key**.

<figure><img src="https://3137140735-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZcl3T6ePz95GpzjAeOLW%2Fuploads%2FOOYdYBzC7xt3ixdOb9du%2FPermission%20for%20API%20Key.gif?alt=media&#x26;token=5515309c-8706-4c32-bc3d-8182ca8d678c" alt=""><figcaption></figcaption></figure>

### API Secret

The API Secret will be generated and you have to copy and paste it somewhere safe. You will find the **API Key ID** on the API Keys tab.

{% hint style="warning" %}
It's crucial to safely store your API Secret immediately as it's not retrievable after the initial display. Always access your API Key ID from the API Keys tab for future references.
{% endhint %}

<figure><img src="https://3137140735-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZcl3T6ePz95GpzjAeOLW%2Fuploads%2Fg9LXbuEK4XpBLyAgkEoh%2FAPI%20Secret.gif?alt=media&#x26;token=fde1df63-58c0-464e-90df-853fded8a548" alt=""><figcaption></figcaption></figure>

In conclusion, an API Key and API Secret are crucial components for securing your interactions with Gallabox's services. You can easily create an API Key in Gallabox by navigating to the API Keys tab, ensuring your API integrations are both robust
