Jipy License

Integrate Jipy License into clients and CI — license checks plus product release uploads (JavaScript, TypeScript, Python, Lua).

License Check API

POST /api/license/check

Plain Text

1	`POST /api/license/check`

Headers

Authorization: Bearer <license-key> — required
x-product-version: 1.2.3 — optional, enables changelog filtering
Content-Type: application/json

Request body

{
  "UserName": "player-name",
  "Product": "product-id",
  "UserID": "unique-user-id",
  "IncludeAllChangelog": false
}

JSON

1	`{`
2	`"UserName": "player-name",`
3	`"Product": "product-id",`
4	`"UserID": "unique-user-id",`
5	`"IncludeAllChangelog": false`
6	`}`

Status codes

Every response includes a status field in the JSON body. The HTTP status code may differ from the application status for some errors.

Status	HTTP	Meaning
`800`	200	License is valid. Returns product info, enabled addition IDs, and optional changelog entries.
`801`	801	License not found — the API key does not exist.
`802`	802	License exists but is not active.
`803`	803	Product mismatch — key is registered to a different product.
`804`	804	Unauthorized IP — request IP is not on the license allowlist.
`805`	805	API key is missing from the Authorization header.
`806`	806	Product field is missing from the request body.
`807`	807	UserID field is missing from the request body.
`808`	806	Username field is missing from the request body.
`810`	500	Internal server error.

Success response

{
  "status": 800,
  "message": "License is valid",
  "isValid": true,
  "active": true,
  "disabled": false,
  "info": {
    "Product": "my-product",
    "authIP": "1.2.3.4",
    "extraIPs": [],
    "additions": ["A7K2"],
    "requestIP": "1.2.3.4",
    "allowAnyIp": false
  },
  "product": { "name": "...", "version": "1.0.0" },
  "changelog": []
}

JSON

1	`{`
2	`"status": 800,`
3	`"message": "License is valid",`
4	`"isValid": true,`
5	`"active": true,`
6	`"disabled": false,`
7	`"info": {`
8	`"Product": "my-product",`
9	`"authIP": "1.2.3.4",`
10	`"extraIPs": [],`
11	`"additions": ["A7K2"],`
12	`"requestIP": "1.2.3.4",`
13	`"allowAnyIp": false`
14	`},`
15	`"product": { "name": "...", "version": "1.0.0" },`
16	`"changelog": []`
17	`}`

When autoActivateOnFirstCheck is enabled in site settings, an inactive license with no bound IP will activate automatically on the first successful check from a valid IP.

Example (curl)

curl -X POST https://your-domain/api/license/check \
  -H "Authorization: Bearer YOUR-LICENSE-KEY" \
  -H "Content-Type: application/json" \
  -H "x-product-version: 1.0.0" \
  -d '{"UserName":"server","Product":"my-product","UserID":"srv-01"}'

Bash

1	`curl -X POST https://your-domain/api/license/check \`
2	`-H "Authorization: Bearer YOUR-LICENSE-KEY" \`
3	`-H "Content-Type: application/json" \`
4	`-H "x-product-version: 1.0.0" \`
5	`-d '{"UserName":"server","Product":"my-product","UserID":"srv-01"}'`

Product Upload API

Automate release archives and catalog updates from CI. Authenticate with the PRODUCT_UPLOAD_API_KEY env secret. Use the stable product id (e.g. my_script), not the Mongo ObjectId.

Authentication

X-Api-Key: <PRODUCT_UPLOAD_API_KEY> — preferred
or Authorization: Bearer <PRODUCT_UPLOAD_API_KEY>

If the key is unset on the server, all endpoints return 503. Invalid keys return 401. Rate limited to 20 requests / minute / IP.

Endpoints

Method	Path	Purpose
`GET`	`/api/products`	List products
`GET`	`/api/products/:productId`	Product detail + releases
`PATCH`	`/api/products/:productId`	Update catalog fields (JSON)
`GET`	`/api/products/:productId/releases`	List releases
`POST`	`/api/products/:productId/releases`	Upload / replace a release archive
`DELETE`	`/api/products/:productId/releases/:version`	Delete a release

Upload a release

multipart/form-data with version, file (.zip / .rar / .7z, max 200 MB), and optional updateCatalogVersion=true to bump the shop version string. Jipy Tool products are rejected — use the Blender Repo admin flow instead.

curl -X POST https://your-domain/api/products/my_script/releases \
  -H "X-Api-Key: YOUR-PRODUCT-UPLOAD-API-KEY" \
  -F "version=1.4.0" \
  -F "updateCatalogVersion=true" \
  -F "file=@./my_script-1.4.0.zip"

Bash

1	`curl -X POST https://your-domain/api/products/my_script/releases \`
2	`-H "X-Api-Key: YOUR-PRODUCT-UPLOAD-API-KEY" \`
3	`-F "version=1.4.0" \`
4	`-F "updateCatalogVersion=true" \`
5	`-F "file=@./my_script-1.4.0.zip"`

const API = "https://your-domain";
const KEY = process.env.PRODUCT_UPLOAD_API_KEY!;

async function uploadRelease(
  productId: string,
  version: string,
  filePath: string
): Promise<void> {
  const { readFile } = await import("node:fs/promises");
  const { basename } = await import("node:path");
  const bytes = await readFile(filePath);
  const form = new FormData();
  form.set("version", version);
  form.set("updateCatalogVersion", "true");
  form.set("file", new File([bytes], basename(filePath)));

  const res = await fetch(`${API}/api/products/${productId}/releases`, {
    method: "POST",
    headers: { "X-Api-Key": KEY },
    body: form
  });
  const data = await res.json();
  if (!res.ok || !data.success) {
    throw new Error(data.error ?? res.statusText);
  }
  console.log(data.release);
}

TypeScript

1	`const API = "https://your-domain";`
2	`const KEY = process.env.PRODUCT_UPLOAD_API_KEY!;`
3
4	`async function uploadRelease(`
5	`productId: string,`
6	`version: string,`
7	`filePath: string`
8	`): Promise<void> {`
9	`const { readFile } = await import("node:fs/promises");`
10	`const { basename } = await import("node:path");`
11	`const bytes = await readFile(filePath);`
12	`const form = new FormData();`
13	`form.set("version", version);`
14	`form.set("updateCatalogVersion", "true");`
15	`form.set("file", new File([bytes], basename(filePath)));`
16
17	const res = await fetch(`${API}/api/products/${productId}/releases`, {
18	`method: "POST",`
19	`headers: { "X-Api-Key": KEY },`
20	`body: form`
21	`});`
22	`const data = await res.json();`
23	`if (!res.ok \|\| !data.success) {`
24	`throw new Error(data.error ?? res.statusText);`
25	`}`
26	`console.log(data.release);`
27	`}`

Update catalog metadata

curl -X PATCH https://your-domain/api/products/my_script \
  -H "X-Api-Key: YOUR-PRODUCT-UPLOAD-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"1.4.0","display":true,"description":"Release notes…"}'

Bash

1	`curl -X PATCH https://your-domain/api/products/my_script \`
2	`-H "X-Api-Key: YOUR-PRODUCT-UPLOAD-API-KEY" \`
3	`-H "Content-Type: application/json" \`
4	`-d '{"version":"1.4.0","display":true,"description":"Release notes…"}'`

const API = "https://your-domain";
const KEY = process.env.PRODUCT_UPLOAD_API_KEY!;

async function patchProduct(
  productId: string,
  fields: { version?: string; display?: boolean; description?: string }
): Promise<void> {
  const res = await fetch(`${API}/api/products/${productId}`, {
    method: "PATCH",
    headers: {
      "X-Api-Key": KEY,
      "Content-Type": "application/json"
    },
    body: JSON.stringify(fields)
  });
  const data = await res.json();
  if (!res.ok || !data.success) {
    throw new Error(data.error ?? res.statusText);
  }
}

TypeScript

1	`const API = "https://your-domain";`
2	`const KEY = process.env.PRODUCT_UPLOAD_API_KEY!;`
3
4	`async function patchProduct(`
5	`productId: string,`
6	`fields: { version?: string; display?: boolean; description?: string }`
7	`): Promise<void> {`
8	const res = await fetch(`${API}/api/products/${productId}`, {
9	`method: "PATCH",`
10	`headers: {`
11	`"X-Api-Key": KEY,`
12	`"Content-Type": "application/json"`
13	`},`
14	`body: JSON.stringify(fields)`
15	`});`
16	`const data = await res.json();`
17	`if (!res.ok \|\| !data.success) {`
18	`throw new Error(data.error ?? res.statusText);`
19	`}`
20	`}`

Lua / FiveM: use PerformHttpRequest for JSON (GET/PATCH/DELETE). For ZIP uploads, shell out to curl or run the TypeScript/Python snippet from CI — native multipart from Lua is painful.

API Documentation

License Check API

Headers

Request body

Status codes

Success response

Example (curl)

Product Upload API

Authentication

Endpoints

Upload a release

Update catalog metadata