Μετάβαση στο περιεχόμενο
ShopentlyLearn

Έλεγχος ταυτότητας

Δημιουργήστε ένα κλειδί API

Για να συνδέσετε την εφαρμογή σας με το κατάστημα, χρειάζεστε ένα κλειδί API. Στον πίνακα διαχείρισης επιλέξτε τα δικαιώματά του, ώστε να ορίσετε ποια δεδομένα μπορεί να διαβάζει η εφαρμογή και τι μπορεί να αλλάζει.

Μπορείτε επίσης να ορίσετε τις διευθύνσεις IP από τις οποίες η εφαρμογή θα συνδέεται στο API. Αν τις ορίσετε, το κλειδί θα χρησιμοποιείται μόνο από αυτές τις διευθύνσεις. Έπειτα δημιουργήστε το κλειδί API.

Λάβε token πρόσβασης

Το token πρόσβασης σας επιτρέπει να στέλνετε αιτήματα χωρίς να μεταβιβάζετε το κλειδί API σε κάθε αίτημα. Μπορείτε να το ανακαλέσετε όταν δεν το χρειάζεστε πλέον.

Μαζί με το token λαμβάνεις τα δικαιώματα και τα όρια αιτημάτων API του καταστήματός σου. Με τη

POST/api/v1/auth/token

Αίτημα cURL

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

Στείλε αιτήματα API

Χρησιμοποίησε το token που έλαβες όταν στέλνεις αιτήματα API. Τήρησε τα όρια αιτημάτων του καταστήματος. Η πρόσβαση στις λειτουργίες εξαρτάται επίσης από τα δικαιώματα του προγράμματός σου.

Αν χρειάζεται να επιλέξετε γλώσσα ή αγορά για τα αιτήματά σας, ανακτήστε το πλαίσιο του καταστήματος. Θα λάβετε τις διαθέσιμες γλώσσες και αγορές με τους κωδικούς και τα αναγνωριστικά τους.

Ανάκλησε το token

Η ανάκληση του token είναι προαιρετική. Αν το χρησιμοποιείτε για μία εργασία, συνιστούμε να το ανακαλέσετε όταν τελειώσετε. Αν δεν ανακαλέσετε το token χειροκίνητα, θα ισχύει μέχρι να λήξει η καθορισμένη διάρκειά του. Μετά δεν θα μπορεί να χρησιμοποιηθεί.

POST/api/v1/auth/revoke

Αίτημα cURL

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