REST API¶

Getting Started¶

The Shrinkit REST API lets you create and manage Shrinkit resources programmatically — short links, and the data behind your campaigns — from your own backend, a scheduled job, or another store platform.

Base URL¶

https://api.shrinkit.me

Every endpoint is scoped to one store, and the store is identified by its Store ID in the path:

https://api.shrinkit.me/apps/{project_id}/...

{project_id} is your Store ID.

Authorization¶

You need two values, both from the dashboard: open Store settings → API Key and copy the Store ID and API Key.

API Key

Value	Where it goes
Store ID	The `{project_id}` path segment
API Key	The `appApiKey` request header

curl --request POST \
  --url https://api.shrinkit.me/apps/{project_id}/smartlinks \
  --header 'appApiKey: YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{ ... }'

Keep the API key server-side

The API key grants full access to your store's data. Call the API from your backend and never ship the key in browser JavaScript, a mobile app binary, or a public repo.

Request format¶

Requests that send a body must use Content-Type: application/json. A request with any other content type is rejected with 406 Not Acceptable.

Response format¶

Every response is JSON and carries a status field. Success responses add whatever the endpoint returns:

{
  "status": "success",
  "message": "successfully created",
  "smartlink": "https://yourstore.shrinkit.me/s/TreMp"
}

Errors use the same envelope with "status": "failed" and a human-readable message:

{
  "status": "failed",
  "message": "Conflict, slug not available."
}

Status codes¶

Code	Meaning
`200`	Request succeeded
`201`	Resource created
`400`	The payload failed validation — `message` names the offending value
`401`	The `appApiKey` header is missing or the key is not valid
`403`	The key is valid but not allowed to act on this store
`404`	No such store or resource
`405`	That method is not allowed on this endpoint
`406`	`Content-Type` was not `application/json`
`409`	Conflict — the value must be unique and is already taken
`500`	Server error

Install Shrinkit on your store¶

Shrinkit works with Salla, Zid and Shopify. Install the app on your store and your orders, carts, products and customers appear in the dashboard automatically — no coding, no data import.

Install on Salla Install on Zid Install on Shopify

Not on any of those platforms yet? Talk to us on WhatsApp.