Awtentikazzjoni

1Oħloq ċavetta API

Biex tqabbad l-applikazzjoni tiegħek mal-ħanut, għandek bżonn ċavetta API. Fil-pannell tal-amministrazzjoni, agħżel il-permessi li jiddeterminaw liema data tista’ taqra l-applikazzjoni u x’tista’ tbiddel.

Tista’ wkoll tindika l-indirizzi IP li l-applikazzjoni se tuża biex taċċessa l-API. Jekk tindikahom, iċ-ċavetta tkun tista’ tintuża biss minn dawk l-indirizzi. Imbagħad oħloq iċ-ċavetta API.

2Ikseb token tal-aċċess

Token ta’ aċċess jippermettilek tibgħat talbiet mingħajr ma tibgħat iċ-ċavetta API f’kull talba. Tista’ tirrevoka t-token meta ma jkollokx bżonnu aktar.

Mat-token tirċievi wkoll il-permessi u l-limiti tat-talbiet API tal-ħanut tiegħek. Meta

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/token \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"ttl_seconds":1800}'

{
  "data": {
    "access_token": "EXAMPLE_ACCESS_TOKEN",
    "expires_at": "2026-01-01T12:15:00Z",
    "expires_in": 1800,
    "permissions": [
      "orders.order:read"
    ],
    "rate_limits": {
      "auth_per_minute": 1,
      "read_per_minute": 2,
      "write_per_minute": 15
    },
    "token_type": "Bearer",
    "warnings": []
  },
  "meta": {
    "request_id": "example"
  }
}

3Ibgħat talbiet API

Uża t-token li rċevejt meta tibgħat talbiet API. Żomm mal-limiti tat-talbiet tal-ħanut. L-aċċess għal kull operazzjoni jiddependi wkoll mill-permessi tal-pjan tiegħek.

Jekk għandek bżonn tagħżel lingwa jew suq għat-talbiet tiegħek, ġib il-kuntest tal-ħanut. Tirċievi l-lingwi u s-swieq disponibbli bil-kodiċijiet u l-identifikaturi tagħhom.

4Irrevoka t-token

Ir-revoka tat-token hija fakultattiva. Jekk tużah għal kompitu ta’ darba, nirrakkomandaw li tirrevokah meta tispiċċa. Jekk ma tirrevokax it-token manwalment, jibqa’ validu sa tmiem il-perjodu stabbilit. Wara ma jkunx jista’ jintuża.

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/revoke \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"access_token":"EXAMPLE_ACCESS_TOKEN"}'

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}