Kimlik doğrulama

1API anahtarı oluşturun

Uygulamanızı mağazaya bağlamak için bir API anahtarı gerekir. Yönetim panelinde izinleri seçerek uygulamanın hangi verileri okuyabileceğini ve neleri değiştirebileceğini belirleyin.

Uygulamanın API’ye bağlanacağı IP adreslerini de belirtebilirsiniz. Adresleri girerseniz anahtar yalnızca bu adreslerden kullanılabilir. Ardından API anahtarını oluşturun.

2Erişim tokenı al

Erişim tokenı, her istekte API anahtarını göndermeden istek yapmanızı sağlar. Artık ihtiyacınız olmadığında belirteci iptal edebilirsiniz.

Token ile birlikte mağazanın izinlerini ve API istek sınırlarını da alırsın.

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

3API istekleri gönder

API isteklerinde aldığın tokenı kullan. Mağazanın istek sınırlarını aşma. İşlemlere erişim, planının izinlerine de bağlıdır.

İstekleriniz için dil veya pazar seçmeniz gerekiyorsa mağaza bağlamını alın. Kullanılabilir diller ve pazarlar, kodları ve tanımlayıcılarıyla birlikte döndürülür.

4Tokenı iptal et

Tokenı iptal etmek isteğe bağlıdır. Tek seferlik bir iş için kullanıyorsanız iş bittiğinde iptal etmenizi öneririz. Tokenı elle iptal etmezseniz belirlenen geçerlilik süresinin sonuna kadar kullanılabilir. Süre dolunca artık kullanılamaz.

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