Create an API key

POST

api

api-keys

Create an API key

curl --request POST \
  --url https://api.itemshop.dev/api/v2/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Plugin survival",
  "type": "plugin",
  "permissions": [
    "products:read",
    "orders:write"
  ],
  "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
  "expiresAt": "2026-12-31T23:59:59.000Z"
}
'

import requests

url = "https://api.itemshop.dev/api/v2/api-keys"

payload = {
    "name": "Plugin survival",
    "type": "plugin",
    "permissions": ["products:read", "orders:write"],
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "expiresAt": "2026-12-31T23:59:59.000Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Plugin survival',
    type: 'plugin',
    permissions: ['products:read', 'orders:write'],
    shopId: '664f1a2b3c4d5e6f7a8b9c0d',
    expiresAt: '2026-12-31T23:59:59.000Z'
  })
};

fetch('https://api.itemshop.dev/api/v2/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.itemshop.dev/api/v2/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Plugin survival',
    'type' => 'plugin',
    'permissions' => [
        'products:read',
        'orders:write'
    ],
    'shopId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'expiresAt' => '2026-12-31T23:59:59.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.itemshop.dev/api/v2/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"Plugin survival\",\n  \"type\": \"plugin\",\n  \"permissions\": [\n    \"products:read\",\n    \"orders:write\"\n  ],\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.itemshop.dev/api/v2/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Plugin survival\",\n  \"type\": \"plugin\",\n  \"permissions\": [\n    \"products:read\",\n    \"orders:write\"\n  ],\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Plugin survival\",\n  \"type\": \"plugin\",\n  \"permissions\": [\n    \"products:read\",\n    \"orders:write\"\n  ],\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "664f1a2b3c4d5e6f7a8b9c0d",
    "name": "Plugin survival",
    "permissions": [
      "read",
      "write"
    ],
    "type": "plugin",
    "keyPreview": "isk_a1b2...",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

Key name

Required string length: 1 - 100

Example:

"Plugin survival"

type

enum<string>

required

Key type

Available options:

shop,

plugin

Example:

"plugin"

permissions

string[]

Permissions as resource:action (e.g. 'products:write', 'orders:read'). Wildcards: 'products:' (whole resource), '' (everything). Legacy aliases: read/write/delete; the admin alias is rejected. Full catalog at GET /api-keys/permissions.

Example:

["products:read", "orders:write"]

shopId

string

Shop ID (for shop/plugin keys)

Pattern: ^[0-9a-fA-F]{24}$

Example:

"664f1a2b3c4d5e6f7a8b9c0d"

expiresAt

string

Expiration date (ISO 8601)

Example:

"2026-12-31T23:59:59.000Z"

Response

Key created (secret returned once)

success

boolean

Example:

true

data

object

Show child attributes

message

string

Revoke an API key

Create an API key

curl --request POST \
  --url https://api.itemshop.dev/api/v2/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Plugin survival",
  "type": "plugin",
  "permissions": [
    "products:read",
    "orders:write"
  ],
  "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
  "expiresAt": "2026-12-31T23:59:59.000Z"
}
'

import requests

url = "https://api.itemshop.dev/api/v2/api-keys"

payload = {
    "name": "Plugin survival",
    "type": "plugin",
    "permissions": ["products:read", "orders:write"],
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "expiresAt": "2026-12-31T23:59:59.000Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Plugin survival',
    type: 'plugin',
    permissions: ['products:read', 'orders:write'],
    shopId: '664f1a2b3c4d5e6f7a8b9c0d',
    expiresAt: '2026-12-31T23:59:59.000Z'
  })
};

fetch('https://api.itemshop.dev/api/v2/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.itemshop.dev/api/v2/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Plugin survival',
    'type' => 'plugin',
    'permissions' => [
        'products:read',
        'orders:write'
    ],
    'shopId' => '664f1a2b3c4d5e6f7a8b9c0d',
    'expiresAt' => '2026-12-31T23:59:59.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.itemshop.dev/api/v2/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"Plugin survival\",\n  \"type\": \"plugin\",\n  \"permissions\": [\n    \"products:read\",\n    \"orders:write\"\n  ],\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.itemshop.dev/api/v2/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Plugin survival\",\n  \"type\": \"plugin\",\n  \"permissions\": [\n    \"products:read\",\n    \"orders:write\"\n  ],\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Plugin survival\",\n  \"type\": \"plugin\",\n  \"permissions\": [\n    \"products:read\",\n    \"orders:write\"\n  ],\n  \"shopId\": \"664f1a2b3c4d5e6f7a8b9c0d\",\n  \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "664f1a2b3c4d5e6f7a8b9c0d",
    "name": "Plugin survival",
    "permissions": [
      "read",
      "write"
    ],
    "type": "plugin",
    "keyPreview": "isk_a1b2...",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Getting started

Basics

Payments

Order fulfillment

Configuration

API Keys

Shops

Servers

Products

Payment Methods

Blacklist

Discounts

Vouchers

Stats

Storage

Orders

Payments

Components

Metrics

Authorizations

Body

Response