Jeton d'accès API

Un jeton d’accès API est un identifiant unique attribué à un projet particulier ou à plusieurs projets de votre compte. Il authentifie votre compte pour la gestion de vos projets via l’API, y compris les modifications de compte, l’envoi de messages, la modification de projets, etc.

Pushwoosh fournit deux types de jetons d’accès API différents : Serveur et Appareil.

Chaque type de jeton n’est valide que pour sa portée API spécifique. Une erreur d’authentification se produira si le mauvais jeton est utilisé.

Le jeton d’API Serveur est utilisé avec toutes les méthodes de l’API, à l’exception de celles de l’API Appareil. Il doit être inclus dans le corps de la requête, dans le champ auth.

Le jeton d’API Appareil est utilisé exclusivement avec les méthodes de l’API Appareil. Il doit être inclus dans les en-têtes de la requête HTTP à l’aide de l’en-tête Authorization. Vous trouverez ci-dessous un exemple du format d’en-tête correct :

Authorization: Token <device_api_token>

Remplacez <device_api_token> par la valeur réelle de votre jeton d’API Appareil.

Vous pouvez consulter, créer et gérer vos jetons d’accès API dans la section API Access du Panneau de contrôle de Pushwoosh. Pour y accéder, allez dans Settings → API Access.

Par défaut, chaque compte inclut un jeton nommé Pushwoosh Demo App, qui est configuré comme un jeton de serveur.

Pour créer un nouveau jeton d’accès API :

1. Accédez à la section API Access dans le Panneau de contrôle.

2. Cliquez sur Generate New Token.

3. Dans la fenêtre qui s’affiche, choisissez le type de jeton :

   • Serveur utilisé pour la plupart des méthodes de l’API (à l’exclusion des méthodes de l’API Appareil).

   • Appareil utilisé uniquement pour les méthodes de l’API Appareil.

4. Saisissez un nom pour le jeton.

5. Cliquez sur Generate pour créer le jeton.

Important : Assurez-vous de donner au jeton l’accès à la bonne application dans votre Panneau de contrôle Pushwoosh. En savoir plus

Le nouveau jeton apparaîtra dans la liste d’accès à l’API. De là, vous pouvez copier sa valeur pour l’utiliser dans les requêtes API ou gérer ses autorisations d’accès selon vos besoins.

Pour gérer un jeton d’API existant, cliquez sur le menu à trois points (⋮) à côté de l’entrée du jeton dans la section API Access.

Les options suivantes sont disponibles :

Donne au jeton l’accès à tous les projets de votre compte. Cela lui permet d’utiliser pleinement l’API sur tous les projets.

Supprime l’accès du jeton à tous les projets de votre compte. Le jeton ne pourra plus utiliser l’API jusqu’à ce que l’accès soit à nouveau accordé.

Ouvre l’écran Edit API Token Permissions, où vous pouvez :

• Changer le nom du jeton

• Copier la valeur du jeton

• Choisir les projets auxquels le jeton peut accéder en les sélectionnant ou en les désélectionnant dans la liste.

Une fois que vous avez terminé vos modifications, cliquez sur Save pour les appliquer.

Supprime définitivement le jeton de votre compte.

Pour autoriser les requêtes API, utilisez le type de jeton d’accès API approprié en fonction du type de méthode API que vous appelez :

Incluez le jeton dans le champ « auth » du corps de la requête : Exemple :

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // collez votre jeton de serveur ici
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

Utilisez le jeton d’appareil. Incluez-le dans l’en-tête de la requête HTTP en utilisant le format suivant :

Authorization: Token <device_api_token>

Remplacez <device_api_token> par la valeur réelle de votre jeton.