Create an API key
An API key is the credential of your software. It acts as your merchant account and sees only your own data.
Create a key
Section titled “Create a key”- Sign in to the portal: portal.shirtee.cloud.
- Open KI-Assistent & API and switch to API-Schlüssel (API keys).
- Create a key and enter:
| Field | Rule |
|---|---|
| Name | 1 to 64 characters. Pick a name that tells you which software uses it, for example “shop integration”. |
| Permissions | At least one. Only permissions enabled for your account are offered, see Scopes and enablement. |
| Validity | 1 to 365 days, 90 days by default. |
As a check, Shirtee sends an email to the signed-in user with name, identifier, permissions and expiry date. The token is never in the email. If you do not recognize the key, revoke it.
Identifier and status
Section titled “Identifier and status”The list shows an identifier (the first characters), permissions, creation and expiry date and a status of active, revoked or expired. Give support the identifier when you need help with a key. Never give the token.
Changing permissions
Section titled “Changing permissions”A key carries exactly the permissions you chose at creation. If you need more later, create a new key and switch your software to it. You can then revoke the old one.
Revoke a key
Section titled “Revoke a key”Revoke a key in the same area. Revocation takes effect with the next request, which then returns 403 with the message Scoped API key revoked. An expired key returns 401.
Who can create keys
Section titled “Who can create keys”Only signed-in merchants. The key applies to your account. If the user who created it no longer belongs to that merchant, the key also answers 403.
Keep it safe
Section titled “Keep it safe”- Never store the token in source code, tickets or chat messages.
- Use a separate key per piece of software so you can revoke access individually.
- Give a key only the permissions the software needs.
- Enter production keys in the API reference only on your own computer.