Documentation API
La documentation API d 'Affise vous permet de travailler avec les panneaux d'administration et d'affiliation via l'API. La documentation fournit toutes les données nécessaires pour faire des requêtes correctes et obtenir les données en retour.
Il y a des méthodes pour les utilisateurs du panneau d'administration, pour les utilisateurs du panneau d'affiliation (vos affiliés), et des méthodes communes.
Les méthodes sont regroupées en fonction des objectifs que vous souhaitez atteindre : consulter les statistiques, gérer les offres, travailler avec les utilisateurs, etc.
Les responsables généraux peuvent utiliser les méthodes marquées comme méthodes d'administration.
Dans une méthode, vous pouvez voir :
où :
1 : La méthode API et le chemin à ajouter à votre demande API.
2: La liste des paramètres disponibles pour une méthode.
3 : Type de données pour le paramètre.
4 : Le cas échéant, les données ou formats disponibles et par défaut que vous devez utiliser.
5 : Dans la description, vous pouvez trouver des informations supplémentaires sur le paramètre : ce dont il est chargé, s'il est requis ou non, etc.
Dans le volet de droite, vous voyez la réponse :
où :
1 : la requête cURL, que vous pouvez copier, adapter et utiliser dans les outils API, tels que Postman ou Insomnia.
2 : l'exemple de réponse pour une méthode particulière. Vous pouvez y voir les données représentées.
Vous pouvez utiliser le document dédié aux codes d'état. Il peut vous aider à comprendre les erreurs globales dans les réponses de votre API.
Veuillez contacter l'équipe d'assistance à la clientèle d'Affise pour toutes les questions soulevées par le biais de l'e-mail : [email protected].