Za-Pep

Version: 1.0.1
Auteur: Baidem / Vincent POUPAERT

Description

Za-Pep est un plugin WordPress conçu pour envoyer via Zapier des requêtes HTTP sur mesure vers votre API REST de WordPress.

Fonctionnalités

Tester l’authentification depuis Zapier: Permet de vérifier l’authentification depuis un Zap Zapier.
Modifier les groupes d’un utilisateur depuis Zapier : Permet de modifier les groupes du forum WordPress/wpForo d’un utilisateur depuis un Zap Zapier.
Dupliquer un article WordPress : Permet de dupliquer un article WordPress depuis la page Articles du tableau de bord WordPress.
Nettoyage du cache des membres : Permet de nettoyer le cache des membres du forum WordPress/wpForo.
Consulter les fichiers de log : Permet de consulter les logs de l’extension.

Installation

Téléchargez le fichier ZIP du plugin via le dépôt GitLab suivant : https://gitlab.com/Vpoup/za-pep/-/tree/Download_version_1.0.1?ref_type=heads. Cliquer sur le bouton Code → menu déroulant → Télécharger le code source, puis sélectionnez zip.
Dans le tableau de bord WordPress, allez dans Extensions → Ajouter.
Cliquez sur Téléverser une extension, sélectionnez le fichier ZIP, et installez le plugin.
Activez le plugin via le menu Extensions de WordPress.
Installez et activez également les extensions wpForo et Zapier for WordPress.

Utilisation

Vous trouverez toutes les instructions dans la documentation ci-après : documentation

Configuration

Des options de configuration sont disponibles dans le menu de paramètrage de Za-Pep.

Support

Pour toute question ou demande d’assistance, vous pouvez nous contacter à contact@baidem.net.

DOCUMENTATION

Fonctionnalités : Tester votre clé API depuis Zapier

Description

Cette fonctionnalité permet de vérifier si la clé API a bien été définie à l’aide de l’adresse URL fournie dans le menu d’administration.

Utilisation

Dans votre tableau de bord WordPress, allez dans le menu de paramétrage de Za-Pep.
Copiez votre clé API ainsi que l’URL de test.
Dans un Zap Zapier, ajoutez une étape WordPress, puis choisissez dans le setup l’Action event → API Request
Dans l’Account du setup, configurez le compte WordPress correspondant au site de votre projet.
Puis allez sur l’onglet Configure
Choisissez HTTP Method -> GET
Entrez l’URL fournie dans le menu d’administration de Za-Pep dans le champ URL
Ajoutez un Additional Request Header nommé x-api-key, puis entrez la clé API dans la valeur
Testez votre clé API dans l’onglet Test en cliquant sur le bouton Test.
Si la clé est valide, un message de succès (statut 200) s’affichera.
Sinon, un message d’erreur apparaîtra : statut 404 pour une erreur d’URL ou statut 403 pour une clé invalide.
Après validation, vous pouvez ajouter un Zap dans Zapier qui appelle Za-Pep pour tester que la clé et la connexion fonctionnent correctement.
Il est à noter que cette fonctionnalité vérifie également le token d’authentification envoyé par Zapier. D’où l’importance d’activer correctement l’extension Zapier for WordPress, afin de vérifier que l’utilisateur ayant envoyé le Zap possède bien le rôle d’administrateur..

Fonctionnalités : Modifier les groupes d’un utilisateur depuis Zapier

Description

Cette fonctionnalité vous permet de modifier les groupes du forum WordPress/wpForo d’un utilisateur depuis un Zap Zapier.

Utilisation

Dans votre tableau de bord WordPress, allez dans le menu de paramétrage de Za-Pep.
Dans la partie Paramètres des groupes wpForo cochez les cases des groupes autorisés, c’est-à-dire que seuls les groupes cochés pourront être utilisés dans les requêtes Zapier. Enregistrez les modifications avec le bouton ‘Enregistrer les modifications’ situé juste en dessous de la liste des groupes.
Copiez votre clé API ainsi que l’URL de la fonctionnalité.
Dans un Zap Zapier, ajoutez une étape WordPress et choisissez dans le setup l’Action event -> API Request
Dans l’Account du setup, configurez le compte WordPress correspondant au site de votre projet.
Puis allez sur l’onglet Configure
Choisissez HTTP Method -> PATCH
Entrez l’URL fournie dans le menu d’administration de Za-Pep dans le champ URL
Ajoutez les paramètres de requête suivants (Query String Params) :
- user-email : L’adresse e-mail de l’utilisateur
- main-group-name : Le nom du groupe principal
- secondary-group-name : Le nom du groupe secondaire
Configurez les valeurs dynamiquement si nécessaire.
Ajouter une Additional Request Headers nommé x-api-key et entrer la clé API dans la valeur.
Testez votre requête dans l’onglet Test en cliquant sur le bouton Test step (ou Retest step).
Si la requête est passée correctement, un message de succès (statut 200) s’affichera.
Sinon, un message d’erreur apparaîtra. Le message contient des informations utiles pour résoudre le problème.
Une fois la requête validée, vous pouvez créer un Zap dans Zapier afin de modifier les groupes d’un utilisateur via Za-Pep..

Fonctionnalités : Nettoyage du cache des membres

Description

Cette fonctionnalité vous permet de dupliquer un article WordPress depuis la page Articles du tableau de bord WordPress.

Utilisation

Ouvrir la page Articles du tableau de bord WordPress.
Dans le tableau qui liste les articles, Survolez l’article que vous souhaitez dupliquer.
Les options des actions disponibles apparaissent sous le titre de l’article.
Cliquer sur Dupliquer pour dupliquer l’article.
Un nouvel article identique à celui que vous avez sélectionné apparaît dans la liste des articles.

Fonctionnalités : Tester votre clé API depuis Zapier

Description

Cette fonctionnalité permet de nettoyer le cache des membres du forum WordPress/wpForo. L’affichage de l’administrateur des membres est dépendant du cache de WordPress.

Pour être sûr que l’affichage est bien synchronisé avec la base de données WordPress, on peut nettoyer le cache de tous les membres.

Utilisation

Dans votre tableau de bord WordPress, allez dans le menu de paramétrage de Za-Pep.
Faites défiler jusqu’à la section Nettoyage du cache des membres.
Cliquez sur le bouton Effacer cache.
Un message de succès s’affichera.
Le cache est automatiquement réinitialisé et synchronisé avec la base de données WordPress.

Fonctionnalités : Consulter les logs

Description

Il est possible de consulter les logs de l’extension Za-Pep en téléchargeant le fichier de logs.

Utilisation

Dans votre tableau de bord WordPress, allez dans le menu de paramétrage de Za-Pep.
Scroller jusqu’à la section Fichier de logs.
Pour télécharger le fichier de logs, cliquez sur le bouton ‘Télécharger les logs’.
Le fichier de logs est téléchargé sur votre ordinateur.