Aller au contenu
ShopentlyLearn
Français

Authentification

Créer une clé API

Pour connecter votre application à la boutique, vous avez besoin d’une clé API. Dans le panneau d’administration, choisissez ses autorisations pour définir les données que l’application peut lire et ce qu’elle peut modifier.

Vous pouvez aussi indiquer les adresses IP depuis lesquelles l’application accédera à l’API. Si vous les renseignez, la clé ne pourra être utilisée que depuis ces adresses. Créez ensuite la clé API.

Obtenir un jeton d’accès

Un jeton d’accès permet d’envoyer des requêtes sans transmettre la clé API dans chaque requête. Vous pouvez le révoquer lorsque vous n’en avez plus besoin.

Le jeton est accompagné des autorisations et des limites de requêtes API de votre boutique.

POST/api/v1/auth/token

Requête 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}'

Réponse 

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

Envoyer des requêtes API

Utilisez le jeton reçu pour envoyer vos requêtes API. Respectez les limites de requêtes de votre boutique. L’accès aux opérations dépend aussi des autorisations de votre forfait.

Si vous devez choisir une langue ou un marché pour vos requêtes, récupérez le contexte de la boutique. Vous recevrez les langues et marchés disponibles avec leurs codes et identifiants.

Révoquer le jeton

La révocation d’un jeton est facultative. Si vous l’utilisez pour une tâche ponctuelle, nous recommandons de le révoquer une fois le travail terminé. Sans révocation manuelle, le jeton restera utilisable jusqu’à la fin de sa durée de validité. Il ne pourra plus être utilisé ensuite.

POST/api/v1/auth/revoke

Requête 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"}'

Réponse 

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