Fíordheimhniú

1Cruthaigh eochair API

Teastaíonn eochair API uait chun d’fheidhmchlár a nascadh leis an siopa. Sa phainéal riaracháin, roghnaigh na ceadanna a shocraíonn na sonraí is féidir leis an bhfeidhmchlár a léamh agus na rudaí is féidir leis a athrú.

Is féidir leat na seoltaí IP a úsáidfidh an feidhmchlár chun rochtain a fháil ar an API a shonrú freisin. Má shonraíonn tú iad, ní oibreoidh an eochair ach ó na seoltaí sin. Ansin cruthaigh an eochair API.

2Faigh comhartha rochtana

Le comhartha rochtana, is féidir iarratais a sheoladh gan an eochair API a chur i ngach iarratas. Is féidir an comhartha a chúlghairm nuair nach bhfuil sé uait a thuilleadh.

Gheobhaidh tú ceadanna agus teorainneacha iarratas API do shiopa in éineacht leis an gcomhartha. Le

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"
  }
}

3Seol iarratais API

Úsáid an comhartha a fuair tú agus iarratais API á seoladh agat. Cloígh le teorainneacha iarratas do shiopa. Braitheann rochtain ar oibríochtaí freisin ar cheadanna do phlean.

Más gá teanga nó margadh a roghnú do d’iarratais, faigh comhthéacs an tsiopa. Gheobhaidh tú na teangacha agus na margaí atá ar fáil, lena gcóid agus lena n-aitheantóirí.

4Cúlghair an comhartha

Tá cúlghairm an chomhartha roghnach. Má úsáideann tú é do thasc aonuaire, molaimid é a chúlghairm nuair a bhíonn an obair críochnaithe. Mura gcúlghaireann tú an comhartha de láimh, beidh sé bailí go dtí deireadh na tréimhse socraithe. Ní féidir é a úsáid ina dhiaidh sin.

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"
  }
}