> For the complete documentation index, see [llms.txt](https://help.solink.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.solink.com/docs/install-connect-and-integrate/api-self-management.md).

# API Self Management

Solink provides a **self-managed API** feature that lets you create and manage your own API credentials for integrations. This page documents how to enable API access and manage API keys through the Solink platform.

**Note:** For more information about how to use the Solink API, see the [API documentation](https://apidocs.solink.com/reference/introduction).

***

## Requirements

In order to enable API access and view the **Developer** page, you must have Solink admin access and have no location restrictions tied to your account.

***

## Create an API Key

Follow the steps below to create your Solink API key.

### Step 1: Open Developer Page

1. In the Solink platform, select **Settings** from the profile dropdown menu:

<img src="https://1562067156-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlMN1EUQcXYfv7FYpGJWR%2Fuploads%2Fgit-blob-779e713796e88ae11e28c07e8cfd83d76e3e4f9c%2F77a7e25699ac09e3.png?alt=media" alt="" width="560">

2. Select the **Developer** page.
3. You will see a list of **existing API keys** for your account or organization:

<img src="https://1562067156-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlMN1EUQcXYfv7FYpGJWR%2Fuploads%2Fgit-blob-0f9ccd0b1b94e3e22a30842381b1829675eccb1b%2F8d11dffd6f879df1.png?alt=media" alt="" width="640">

**Note**: Do not delete existing keys unless you know exactly what they are used for. Deleting a key in use can break active integrations (POS systems, webhooks, third-party tools, etc.).

### Step 2: Create a New API Key

1. Select **+** **New API Key**.
2. Enter a **descriptive name** (e.g. integration name, project, or ticket reference).
3. The system generates a **ClientID**, **ClientSecret**, and **API key**.

<img src="https://1562067156-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlMN1EUQcXYfv7FYpGJWR%2Fuploads%2Fgit-blob-f52bf895a070c0c1aead992bcb2dce63d72c5e66%2F707155582ada7481.png?alt=media" alt="" width="640">

### Step 3: Save Credentials and Finish

1. **Copy and store all three values** in a secure location (password manager, secrets vault, etc.). These may only be shown once at creation time.
2. Check the confirmation **checkbox** acknowledging you have saved the credentials.
3. Select **Done**.

<img src="https://1562067156-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlMN1EUQcXYfv7FYpGJWR%2Fuploads%2Fgit-blob-60d9cea30d2fccf677feeff141f70e0e69cfc7b3%2Fb727db2fd6a6f598.png?alt=media" alt="" width="640">

***

## Credentials Reference

Each new key generates three credentials, outlined in the table below:

| **Credential**   | **Purpose**                                     |
| ---------------- | ----------------------------------------------- |
| **ClientID**     | OAuth/client identifier for API authentication. |
| **ClientSecret** | Secret paired with the ClientID.                |
| **API key**      | API access credential for integrations.         |

## Best Practices

Follow these best practices to ensure you create and manage API keys succesfully:

* Never delete keys unless you know what integration they power
* Save credentials immediately — secrets may not be retrievable later
* Use clear, descriptive names (e.g. *Toast Integration - Store 121*)
* Store credentials in a password manager or team secrets vault
* Create one key per integration for easier rotation and revocation


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.solink.com/docs/install-connect-and-integrate/api-self-management.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
