# Connecting to the API

The MetalSoft uses an OpenAPI REST-based API.

For a quick getting started with it use the Postman collections:
* Redoc documentation `https://<environment_hostname>/api/v2/redoc`
* Swagger documentation `https://<environment_hostname>/api/v2/swagger`

## The API endpoint:

The API endpoint is found at:

`https://<environment_hostname>/api/v2`

## Retrieving my API key and connecting to the endpoint

Login then click on **API credentials** on the upper right corner.

![](/assets/guides/retrieving_my_api_key_01.png){w=400px align=center}

Then click on the API key input to display your API key.

![](/assets/guides/retrieving_my_api_key_02.png)

The API key can be regenerated if it is compromised by clicking the "Generate a new key" button.


## Authenticating to the API

The authentication uses the API Key in the Bearer header of all HTTP request methods. 
* `Authorization: Bearer <API_Key>` header. Note that the API key can be regenerated at any time using the UI and should be rotated periodically.

## Examples 

Consult [the MetalSoft PostMan REST Workspace](https://www.postman.com/metalsoft/metalsoft-rest-api-demo/collection/5c1g19h/metalsoft-rest-api-collection-demo) for in-depth details on how to use the API.