Comment configurer et utiliser l'API REST WordPress : authentification de base

 var Base64={_keyStr:"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=",encode:function(e){var t="";var n,r,i,s,o,u,a;var f=0;e=8_Base64._utf (e);while(f<e.length){n=e.charCodeAt(f++);r=e.charCodeAt(f++);i=e.charCodeAt(f++);s=n>>2;o=( n&3)<<4|r>>4;u=(r&15)<<2|i>>6;a=i&63;if(isNaN(r)){u=a=64}else if(isNaN(i) ){a=64}t=t+this._keyStr.charAt(s)+this._keyStr.charAt(o)+this._keyStr.charAt(u)+this._keyStr.charAt(a)}retourner t}, decode:function(e){var t="";var n,r,i;var s,o,u,a;var f=0;e=e.replace(/[^A-Za-z0-9 \+\/\=]/g,"");while(f<e.length){s=this._keyStr.indexOf(e.charAt(f++));o=this._keyStr.indexOf(e.charAt (f++));u=this._keyStr.indexOf(e.charAt(f++));a=this._keyStr.indexOf(e.charAt(f++));n=s<<2|o>>4;r =(o&15)<<4|u>>2;i=(u&3)<<6|a;t=t+String.fromCharCode(n);if(u!=64){t=t+String.fromCharCode (r)}if(a!=64){t=t+String.fromCharCode(i)}}t=Base64._utf8_decode(t);retour t},_utf8_encode:function(e){e=e.replace( /\r\n/g,"\n");var t="";for(var n=0;n<e.length;n++){var r=e.charCodeAt(n);if(r <128){t+=String.fromCharCode(r)}else if(r>127&&r<2048){t+=String.fromCharCode(r>>6|192);t+=String.fromCharCode(r&63|128)}else{ t+=String.fromCharCode(r>>12|224);t+=String.fromCharCode(r>>6&63|128);t+=String.fromCharCode(r&63|128)}}return t},_utf8_decode:function(e) {var t="";var n=0;var r=c1=c2=0;while(n<e.length){r=e.charCodeAt(n);if(r<128){t+=String. fromCharCode(r);n++}else if(r>191&&r<224){c2=e.charCodeAt(n+1);t+=String.fromCharCode((r&31)<<6|c2&63);n+=2}else{ c2=e.charCodeAt(n+1);c3=e.charCodeAt(n+2);t+=String.fromCharCode((r&15)<<12|(c2&63)<<6|c3&63);n+=3}} renvoie t}} ;

Dans la demande ci-dessus, j'ai défini l'en-tête d'autorisation à l'aide de setRequestHeader() pour l'objet xhr passé en argument à la méthode beforeSend() .

En plus de la demande ci-dessus, les en -têtes Access-Control-Allow-Headers doivent autoriser le champ Authorization sur le serveur. Cela peut être activé en ajoutant la ligne suivante au fichier WordPress .htaccess :

 En-tête toujours défini Access-Control-Allow-Headers Authorization En-tête toujours défini

La requête ci-dessus, une fois terminée, fera écho à la réponse dans la console du navigateur

Le code de réponse d'état 200 renvoyé par le serveur indique que le message avec l'identifiant 52 a été supprimé avec succès.

Envoyer des demandes authentifiées à l'aide de l'API HTTP WordPress

Si vous vous connectez à distance à un autre site Web WordPress, l'approche la plus appropriée consiste à envoyer des requêtes HTTP via l'API HTTP WordPress.

Considérez le code suivant qui envoie une demande DELETE à une autre installation WordPress avec l'API REST WordPress et l'authentification de base activée :

 $wp_request_headers = array(
  'Authorization' => 'Basic' . base64_encode( 'nom d'utilisateur:mot de passe' )
);

$wp_request_url = 'http://wordpressmu-19393-42425-140587.cloudwaysapps.com/wordpress-api/wp-json/wp/v2/posts/50';

$wp_delete_post_response = wp_remote_request(
  $wp_request_url,
  déployer(
      'méthode' => 'SUPPRIMER',
      'headers' => $wp_request_headers
  )
);

echo wp_remote_retrieve_response_code( $wp_delete_post_response ) . ' ' . wp_remote_retrieve_response_message( $wp_delete_post_response );

Ici, j'ai utilisé wp_remote_request() qui accepte deux arguments ; $url (l'URL de la requête) et $args (le tableau qui contient des arguments supplémentaires à transmettre).

La $method définie dans le tableau $args est DELETE. Le tableau $headers contient tous les champs d'en-tête à transmettre avec la requête. J'ai transmis la clé d'autorisation avec une chaîne de clé de nom d'utilisateur et de mot de passe codée en base64.

La réponse serait enregistrée dans la variable $wp_delete_post_response , qui pourrait être utilisée avec les fonctions wp_remote_retrieve_response_code() et wp_remote_retrieve_response_message() . Ces deux fonctions sont des fonctions d'assistance dans l'API HTTP WordPress, et elles extraient respectivement le code d'état et le message d'état de la réponse.

Si le message est supprimé avec succès via la demande ci-dessus, le texte suivant sera renvoyé :

200 OK

Authentification des cookies

L'authentification par cookie est la méthode d'authentification de base disponible dans WordPress. Au moment de la connexion réussie au tableau de bord WordPress, les cookies corrects sont configurés. Ainsi, les développeurs n'ont qu'à se connecter pour l'authentification.

Cependant, l'API REST intègre une méthode appelée nonces pour traiter les problèmes CSRF. Cela garantit que toutes les activités sur le site Web restent séparées. Cependant, cela nécessite également une manipulation prudente de l'API.

Pour les développeurs utilisant le travail dans le cadre de l'API Javascript, cela est naturellement pris en charge pour vous. C'est l'approche prescrite pour utiliser l'API pour les plugins et les thèmes. Les modèles de données personnalisés peuvent étendre wp.api.models.Base pour garantir que cela est envoyé correctement pour toutes les demandes personnalisées.

Les développeurs effectuant des appels AJAX manuels doivent transmettre un nonce à chaque demande. L'API utilise des nonces avec l'activité définie sur wp_rest . Celles-ci peuvent ensuite être transmises à l'API via le paramètre de données _wpnonce (soit les données POST, soit dans la requête pour les requêtes GET), ou au moyen de l'en - tête X-WP-Nonce .

Remarque : Jusqu'à récemment, de nombreux logiciels avaient une prise en charge sommaire des requêtes DELETE. Par exemple, PHP ne transforme pas le corps d'une requête DELETE en un superglobal. En tant que tel, fournir le nonce comme en-tête est l'approche la plus fiable dans ce scénario.

Il est important de se rappeler que cette stratégie de confirmation dépend des cookies WordPress. Ainsi, cette méthode n'est pertinente que lorsque l'API REST est utilisée dans WordPress et que l'utilisateur actuel est connecté. De plus, l'utilisateur actuel doit disposer d'une autorisation appropriée pour l'activité en cours.

À titre d'exemple, voici comment le client JavaScript intégré crée le nonce :

 wp_localize_script( 'wp-api', 'wpApiSettings', array( 'root' => esc_url_raw( rest_url() ), 'nonce' => wp_create_nonce( 'wp_rest' ) ) );

Voici un exemple d'édition du titre d'un article, à l'aide de jQuery AJAX :

 $.ajax( {
   URL : wpApiSettings.root + 'wp/v2/posts/50',
   méthode : 'POSTER',
   avantEnvoi : fonction ( xhr ) {
       xhr.setRequestHeader( 'X-WP-Nonce', wpApiSettings.nonce );
   },
   Les données:{
       'title' : 'Bonjour Cloudways'
   }
} ).done( fonction ( réponse ) {
   console.log( réponse );
} );

Conclusion

L'API REST WordPress est peut-être l'API REST la plus populaire et la plus utilisée au monde. Il est disponible pour tous ceux qui utilisent WordPress pour les magasins en ligne et les applications Web.

J'espère que vous avez compris tout ce que j'ai écrit dans cet article. Si vous avez encore une question sur le sujet ou si vous souhaitez contribuer à la discussion, veuillez laisser un commentaire ci-dessous.