Innifalið í Scale og fyrirtækjaleið

REST API skjölun.

Tengdu utanaðkomandi kerfi, sjálfvirknivæddu verkferla og sæktu gögn úr versluninni ykkar með API.

Auðkenning

Allar API-beiðnir krefjast API-lykils í Authorization haus. Búðu til lykla í Stillingar → Forritari í stjórnborðinu.

curl -H "Authorization: Bearer sk_live_your_key_here" \
  https://your-store.cartico.com/api/v1/products

Takmarkanir

60 beiðnir á mínútu á hvern API-lykil. Ef þú ferð yfir mörkin færðu 429 svar með Retry-After haus.

Uppfletting (pagination)

Endapunktar sem skila lista styðja limit (hámark 250) og offset stika. Svarið inniheldur total fjölda, limit og offset.

GET /api/v1/products?limit=25&offset=50

// Response
{
  "products": [...],
  "total": 142,
  "limit": 25,
  "offset": 50
}

Endapunktar

Method	Endpoint	Lýsing
GET	/api/v1/products	Sækja vörur með síun eftir stöðu, safni eða leit
GET	/api/v1/products/:id	Sækja eina vöru með afbrigðum og valkostum
GET	/api/v1/orders	Sækja pantanir með stöðu-, greiðslu- og dagsetningarsíu
GET	/api/v1/orders/:id	Sækja eina pöntun með vörulínum
PATCH	/api/v1/orders/:id	Uppfæra pöntunarstöðu, afgreiðslu, rakningu eða athugasemdir (krefst write heimild)
GET	/api/v1/customers	Sækja viðskiptavini með leit
GET	/api/v1/customers/:id	Sækja viðskiptavin með heimilisföngum
GET	/api/v1/collections	Sækja vörusöfn
GET	/api/v1/inventory	Sækja birgðastöðu afbrigða, með valkvæmum lágmarksviðmiðum
PATCH	/api/v1/inventory	Uppfæra birgðamagn afbrigðis (krefst write heimild)

Villur

API-ið skilar stöðluðum HTTP stöðukóðum með JSON villuskilaboðum.

401	Óheimilt — vantar eða ógildur API-lykill
403	Bannað — röng áskrift eða ónógar heimildir
404	Fannst ekki — auðlind er ekki til eða tilheyrir ekki versluninni
429	Takmörkun — of margar beiðnir
500	Þjónvilla

Webhooks

Fáið rauntímatilkynningar þegar atburðir gerast í versluninni. Búið til webhook endapunkta í Stillingar → Forritari.

Stuðdir atburðir

order.created	Þegar ný pöntun berst
order.updated	Þegar pöntun er uppfærð
order.cancelled	Þegar pöntun er afturkölluð
order.fulfilled	Þegar pöntun er afgreidd
product.created	Þegar vara er búin til
product.updated	Þegar vara er uppfærð
product.deleted	Þegar vöru er eytt
customer.created	Þegar viðskiptavinur er búinn til
customer.updated	Þegar viðskiptavinur er uppfærður
inventory.updated	Þegar birgðir breytast

Sannprófun

Allar webhook sendingar innihalda X-Cartico-Signature haus með HMAC-SHA256 undirskrift. Sannreynið undirskriftina með leyndarmálinu sem birtist þegar webhook er búinn til.

// Verify webhook signature (Node.js)
import crypto from "crypto";

function verifySignature(payload, signature, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(payload)
    .digest("hex");
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected)
  );
}