# API Keys
### What is the API Keys feature:
A feature developed by Pier Cloud that allows you to create keys to integrate the customer environment with the Pier Cloud service API.
### How to use the API Keys feature:
1. The system will display the side menu with some configuration options, where the "**API Keys**" option must be selected:
2. On the main screen, the system allows you to view the list of registered API Keys and add new Keys by clicking the "**Add**" button:
3. The screen for registering new organizations will be displayed, where you will need to enter the following information:
* **Name**: Provide the name of the organization or application you wish to register
* **Description**: Provide a brief description of the key to be created:
* **Scopes**: Enter the permission role scopes, which will identify the functionalities that the client will have access to and the type of access.
* **Token lifespan**: Determine the duration of the client's access key, by default it will be one hour, but the unit of minutes can also be used.
* **Unit**: Specify the unit of time that will be used in the token duration, which can be hours or minutes.
* For hours, the system allows you to include a maximum of 24h
* For minutes, the system allows you to include a maximum time of 55min
After entering the necessary information, clicking on the "**Save**" button, the system will generate a **Client secret** to be copied, by clicking on the icon "" and stored in a safe location.
* Note: When closing the window, the created secret will no longer be displayed and must be saved in a safe location before closing the window.
When you click **Close**, the system will return to the main API Keys screen, where the key created for the specified lifetime will be displayed.
4. Filters:
On the main screen, the system allows you to apply some search filters:
* **API Keys**: You can search by the name of the key you want to view
* **Status**: You can also search by the status of the key, which are: All, Active and Inactive.
5. Actions:
The system also allows you to perform some actions for each registered organization:
* **Copy to clipboard**: By clicking on the "" icon, the system allows you to copy the information and paste it into a clipboard.
* **Activate / Deactivate**: By clicking on the "" icon, you can activate or deactivate the created key.
* **Delete**: By clicking on the trash can icon "", the system will display a confirmation message for the user to confirm the deletion of the key.
* **Edit**: By clicking on the pencil icon "", the system will open the editing screen, allowing you to change information such as: Name, Description, Scopes, Lifetime and Time Unit. It is not allowed to edit the Client ID.
* **Generate new client secret**: By clicking on the pencil key "", the system allows you to generate a new client secret that will replace the previously generated client secret.
By clicking on the "**Generate new client secret**" button, a window will be displayed with the new secret generated, so that it can be copied and stored in a safe location:
Finally, to access the endpoints using this created key, we have additional documentation that can be accessed via this [link](https://docs.piercloud.com.br/api-docs-pier-cloud/api-pier-cloud/public-routes-en-us).
