L’API développeurs Award Force

Intégrez votre site Web de récompenses et vos applications d’entreprise avec Award Force.

Les points de terminaison et les méthodes disponibles pour les développeurs tiers avec qui travailler sont documentés sur cette page.

L’API Award Force utilise l’authentification OAuth 2 et renvoie les réponses sous format JSON par défaut. Faites-nous savoir si vous avez besoin de réponses formatées XML car elles peuvent être mises à disposition.

Authentification

L’intégration à l’API nécessite que vous ayez une clé API qui peut ensuite être utilisée pour authentifier vos demandes.

1. Configuration de votre clé API

Ces étapes doivent être effectuées par un utilisateur avec des privilèges de compte « Awards manager ».

  1. Connectez-vous à votre compte Award Force
  2. Aller à > « Settings General > Integration »
  3. Notez votre « ID de compte » (requis pour valider vos jetons d’accès)
  4. A côté du champ « API key« , cliquez sur « Generate key « 
  5. Vous verrez le champ clé API peuplé de votre nouvelle clé. Copiez cette clé et gardez-la dans un endroit sûr. Vous ne serez pas en mesure de la voir à nouveau (cependant, vous pouvez générer une nouvelle clé à tout moment — l’ancienne clé cessera de fonctionner)

2. Demande d’un jeton d’accès

Toutes les demandes d’API sont faites contre :

https://api.awardsplatform.com

Avant de pouvoir demander des données de l’API, vous devez d’abord demander un jeton d’accès.

Faites une demande GET pour https://api.awardsplatform.com/access-token/ avec les en-têtes suivants :

Accept: application/vnd.Award Force.v1.0+json
Authorization: Basic YOURAPIKEY

En cas de succès, vous devriez voir les données de réponse suivantes dans votre code :

ACCESSTOKEN

Il s’agit d’une chaîne simple qui est nécessaire pour la prochaine étape et ressemblera à quelque chose comme: 35128adf640ef2eb0a3d9e27594a0b08

Maintenant, nous pouvons commencer à faire des demandes à divers points de terminaison API. Pour ce faire, les URL API changeront, mais les en-têtes suivants seront requis sur chaque demande que vous faites :

Accept: application/vnd.Award Force.v1.0+json
Authorization: Basic YOURACCESSTOKEN
X-Account-Id: YOURACCOUNTID

N’oubliez pas que le jeton d’accès est la chaîne qui a été retournée  lorsque vous avez été authentifiée pour la première fois et que l’ID du compte était la valeur sous la valeur sous «Settings > General > Integration».

 

Terminaisons

Catégories

Pour une liste de catégories, faites une demande GET pour :

https://api.awardsplatform.com/category/

Paramètres pris en charge :

  • per_page: Définir le nombre total d’enregistrements retournés. Maximum 100.
  • page: Quelle page pour commencer les résultats à partir. Par défaut 1.

Entrées

Pour une liste d’entrées, faites une demande GET pour :

https://api.awardsplatform.com/entry/

Par défaut, cela renvoie une liste de 10 entrées avec lesquelles vous pouvez ensuite travailler dans votre code.

Paramètres pris en charge :

  • per_page: Définir le nombre total d’enregistrements retournés. Maximum 100.
  • Page: Quelle page pour commencer les résultats à partir. Par défaut 1.
  • category: Requête pour une catégorie d’entrée spécifique en fournissant l’ID de catégorie (plus sur les catégories plus tard)

Donc, pour demander la page 3 d’une liste avec 20 enregistrements par page, votre demande serait:

https://api.awardsplatform.com/entry/?page=3&per_page=20

Entrée

Pour récupérer le contenu complet d’une entrée, faites une demande GET pour :

https://api.awardsplatform.com/entry/[SLUG]

Le slug pour une entrée est une chaîne alphanumérique de 8 caractères identifiant uniquement l’entrée et est l’une des valeurs retournées dans une demande de liste d’entrées.

Commandes

Pour une liste de commandes, faites une demande GET pour :

https://api.awardsplatform.com/order/

Par défaut, cela renvoie une liste de 10 commandes avec lesquelles vous pouvez ensuite travailler dans votre code.

Paramètres pris en charge :

  • per_page :définir le nombre total de commandes retournées. Maximum 100.
  • Page: quelle page pour commencer les résultats à partir de. Par défaut 1.
  • season: slug de saison à filtrer par.

Si vous connaissez le slug ou l’iD local d’une commande, vous pouvez obtenir tous les détails de cette commande en faisant une demande GET à :

https://api.awardsplatform.com/order/[SLUG|ID]

Commander des articles

Pour une liste d’articles de commande, faites une demande GET pour :

https://api.awardsplatform.com/order-item/

Par défaut, cela renvoie une liste de 10 éléments de commandes avec lesquels vous pouvez ensuite travailler dans votre code.

Paramètres pris en charge :

  • per_page :définir le nombre total de commandes retournées. Maximum 100.
  • page: quelle page pour commencer les résultats à partir. Par défaut 1.

Si vous connaissez le slug ou l’iD local d’une commande, vous pouvez obtenir des articles pour cette commande en faisant une demande GET à :

https://api.awardsplatform.com/order-item/[SLUG|ID]

Utilisateurs

Pour créer un nouvel utilisateur, faites une demande POST pour :

https://api.awardsplatform.com/user/

Cela permettra de retourner le slug qui identifie uniquement l’utilisateur dans Award Force.

Paramètres requis :

  • email
  • firstName
  • lastName

Si un utilisateur avec l’e-mail donné existe déjà, cette action ne créera pas un nouvel enregistrement, mais retournera simplement le slug de l’utilisateur existant.

Jeton d’auth d’utilisateur

Pour demander un jeton d’autorisation au nom d’un utilisateur enregistré (qui peut être utilisé une fois pour connecter cet utilisateur), faites une demande GET pour :

https://api.awardsplatform.com/user/[SLUG]/auth-token

Cela renvoie un jeton alphanumérique qui peut être utilisé en redirigeant l’utilisateur vers :

https://[ACCOUNT_DOMAIN]/login?token=[TOKEN]