Siirry sisältöön
ShopentlyLearn
Suomi

Todentaminen

Luo API-avain

Tarvitset API-avaimen, jotta voit yhdistää sovelluksesi kauppaan. Valitse hallintapaneelissa käyttöoikeudet, jotka määrittävät, mitä tietoja sovellus saa lukea ja mitä se saa muuttaa.

Voit myös määrittää IP-osoitteet, joista sovellus käyttää API:a. Jos määrität ne, avainta voi käyttää vain näistä osoitteista. Luo sitten API-avain.

Hae käyttötunnus

Pääsytokenilla voit lähettää pyyntöjä ilman API-avaimen lähettämistä jokaisessa pyynnössä. Voit peruuttaa tunnisteen, kun et enää tarvitse sitä.

Saat tunnuksen mukana kauppasi käyttöoikeudet ja API-pyyntöjen määrärajoitukset.

POST/api/v1/auth/token

cURL-pyyntö 

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

Vastaus 

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

Lähetä API-pyyntöjä

Käytä saamaasi tunnusta API-pyynnöissä. Noudata kauppasi pyyntörajoja. Käytettävissä olevat toiminnot riippuvat myös palvelupakettisi oikeuksista.

Jos haluat valita pyynnöillesi kielen tai markkinan, hae kaupan konteksti. Saat käytettävissä olevat kielet ja markkinat sekä niiden koodit ja tunnisteet.

Peruuta tunnus

Tokenin mitätöinti on vapaaehtoista. Jos käytät sitä kertaluonteiseen tehtävään, suosittelemme mitätöimään sen tehtävän päätyttyä. Jos et mitätöi tokenia käsin, se on voimassa asetetun ajan loppuun. Sen jälkeen sitä ei voi enää käyttää.

POST/api/v1/auth/revoke

cURL-pyyntö 

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

Vastaus 

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