Quand puis-je utiliser l'API ?


L'API Award Force peut être utilisée à plusieurs fins pour vous aider à gérer votre programme. Vous trouverez ci-dessous une liste des options qui s'offrent à vous. Pour en savoir plus, consultez nos documents complets sur l' 
API (à noter que la documentation est rédigée en anglais). 

Pièces-jointes

 

List attachments Renvoie une liste de pièces jointes.
Get attachment Renvoie une pièce jointe par son jeton (token). La réponse comprend tous les champs de pièce jointe. Les fichiers incluent un lien de téléchargement.
Update attachment Mettre à jour une pièce jointe existante.
Delete attachment Supprimer une pièce jointe existante.

 

Catégorie

List categories Renvoie une liste de catégories.
Get category Renvoie une catégorie par son slug. La réponse se compose de tous les champs de la catégorie. Les images incluent un lien de téléchargement.
Create category Créez une nouvelle catégorie.
Update category Mettre à jour une catégorie existante.
Delete category Supprimer une catégorie existante.
Upload category file Téléchargez une image de catégorie.

 

Section

List chapters Renvoie une liste des sections.
Get chapter Renvoie une section par son slug. La réponse se compose de tous les champs de la section.
Create chapter Créez une nouvelle section.
Update chapter Mettre à jour une section existante.
Delete chapter Supprimer une section existante.
Upload chapter file Téléchargez une image de section.

 

Candidature

List entries Renvoie une liste de candidatures.
Get entry Renvoie une candidature par son slug. La réponse comprend tous les champs de la candidature, y compris les fichiers, les pièces jointes et les contributeurs. Les fichiers incluent un lien de téléchargement. 
Create entry Créez une nouvelle candidature.
Update entry Mettre à jour une candidature existante.
Delete entry Supprimer une candidature existante.
Upload entry file Télécharger un fichier dans un champ de candidature
Upload entry attachment Téléchargez une pièce jointe à une candidature par son onglet.
Tag entry Ajouter des étiquettes à une candidature existante.
Untag entry Supprimer l'étiquette ajoutée à une candidature.

 

Champ

List fields Renvoie une liste de champs.

 

Fichier

Get file info Renvoie les informations sur les fichiers par son jeton (token)

 

Commande

List orders Renvoie une liste de commandes.
Get order Renvoie une commande par son slug.
List order items Renvoie une liste d'éléments liés à la commande donnée.
Update order Mettre à jour les informations de facturation et le statut d'une commande existante.

 

Saison

List seasons Renvoie une liste de saisons.
Get season Renvoie une saison par sa slug. La réponse se compose de tous les champs de la saison.

 

Utilisateur

List users Renvoie une liste d'utilisateurs.
Get user by email Renvoie un utilisateur par son email. La réponse se compose de tous les champs utilisateur, y compris les fichiers. Les fichiers incluent un lien de téléchargement. 
Get user by slug Renvoie un utilisateur par son slug. La réponse se compose de tous les champs utilisateur, y compris les fichiers. Les fichiers incluent un lien de téléchargement. 
Create user Créez un nouvel utilisateur.
Update user

Mettre à jour un utilisateur existant. 

Delete user

Supprimer un utilisateur existant

Upload user file

Télécharger un fichier dans un champ utilisateur.

Get auth token

Renvoie un jeton d'authentification (token) pour un utilisateur donné. La réponse consiste en un jeton (token) qui permet à l'utilisateur de se connecter à l'application à l'aide de SSO. 

Besoin d'aide ? Contactez nous.

Envoyez-nous simplement un message via ce formulaire et nous vous répondrons rapidement !
Notre équipe de réussite client répartie dans le monde entier est là pour vous aider 24 heures sur 24 (pendant nos heures de travail), du lundi au vendredi.