> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/patchworks-services/service-systems/supported-service-systems/plytix-service-connector/finding-service-connector-credentials-for-plytix.md).

# Finding service connector credentials for Plytix

## Required credentials

To [add a Patchworks connector](/product-documentation/patchworks-services/service-connectors/adding-a-service-connector.md) for **Plytix**, the following details are required for authentication:

<table><thead><tr><th>Credential</th><th data-type="checkbox">Required</th><th>Note</th></tr></thead><tbody><tr><td>URL</td><td>true</td><td>This is always: <code>https://www.plytix.com/</code></td></tr><tr><td><a href="#obtaining-credentials">API Key</a></td><td>true</td><td>Created/viewed from API settings in the Plytix dashboard.</td></tr><tr><td><a href="#obtaining-credentials">API Password</a></td><td>true</td><td>Created/viewed from API settings in the Plytix dashboard.</td></tr><tr><td>Version</td><td>true</td><td>Currently, the version is always <strong>1</strong>.</td></tr></tbody></table>

## Obtaining credentials

The credentials listed above are needed so that Patchworks can access the required data in **Plytix**. To obtain API credentials, follow the steps below.

### API Key & API Secret

**Step 1**\
In your browser, open the URL that you use to access the **Plytix** dashboard and log in.

**Step 2**\
Click on your username, displayed in the top right-hand corner:\
\
![](/files/lln0GBHujdEcvBR3Ywfi)

**Step 3**\
From your **profile & account** panel, click the account icon:

![](/files/YQO9LaEqfkQ9qKpeLFh2)

**Step 4**\
From the **account** page, click the **API** tab:

<figure><img src="/files/BJTsXUaO5LA3SgDgjdLf" alt=""><figcaption></figcaption></figure>

**Step 5**\
Click the **create API key** button:

![](/files/ZuSp0yRexnXQa3i1r1G2)

...the **create API key** page is displayed:

<figure><img src="/files/sYQNCKfWOgqjgHSQGRti" alt=""><figcaption></figcaption></figure>

**Step 6**\
Enter a name for this key - we suggest:

```
Patchworks Integration
```

**Step 7**\
Click in the **assigned role** field and select **admin** from the dropdown list.

**Step 8**\
Click the **create API key** button:

<figure><img src="/files/ukSd6h11aO7KO7QR2Js0" alt=""><figcaption></figcaption></figure>

**Step 9**\
The new **API key** is displayed - here you can click the 'eye' icon to access the **API password**:

<figure><img src="/files/GWa3WqmLDpxRADiAccnY" alt=""><figcaption></figcaption></figure>

Add these details to your password manager, ready for your Patchworks setup.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/patchworks-services/service-systems/supported-service-systems/plytix-service-connector/finding-service-connector-credentials-for-plytix.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
