Aide de l'API ApiPluXml

Pour accéder a l'aide

Taper l'adresse de votre site suivi de ?apiPluxml

Pour obtenir les données des catégories au format json:

Taper l'adresse de votre site suivi de ?apiPluxml&categorie

Pour obtenir les données des pages statiques au format json:

Taper l'adresse de votre site suivi de ?apiPluxml&static

Pour obtenir les données des mots clés au format json:

Taper l'adresse de votre site suivi de ?apiPluxml&etiquette

Pour obtenir les données des articles au format json:

Taper l'adresse de votre site suivi de ?apiPluxml&article

Pour obtenir les données des commentaires au format json:

Taper l'adresse de votre site suivi de ?apiPluxml&commentaires

En installant ce plugin, ce sont toutes ces données qui peuvent être consultée à distance sans ouvrir vos pages.

Telecharger ce plugin pour PluXml

sur la page : Plugins de PluXopolis ou depuis github.

Aide

Hook >aucun -|_ Options: GET uniquement -|- Clé de connexion (actuellement inutile)

Utilisation

Activer le plugin - Les données publiques de votre site sont alors aussi consultables via l'Api.

acceder à votre site par son adresse en ajoutant à l'url les données que vous voulez utiliser

Tableaux des données disponibles:

Affichage brut

Le format d'affichage brut au format json est lisible à l'écran. C'est aussi un format standard accessible par de nombreux programmes et scripts.

>En cliquant sur les liens ci-dessous, vous verrez les données(mais lisible) que votre site partage.

Affichage Personnalisé

Les données fournies peuvent-être traitées par differents langages et réutilisées de differentes manieres. Le plugin vous propose un fichier javacript doté de plusieurs fonctions d'affichages et options de configurations pour traiter les données renvoyer par un site où le plugin apiPluXml est activé.Le site peut-être distant ou être le site lui même.

Voici le début du fichier JavaScript avec ces options de configaration à regler à votre convenance

Extrait de apiCalling.js/* fetch API datas */
let s = ''; 
if(ProtocolHTTP != 'http') s='s';
function getPlxApiResult(u,q) {
	fetch('//'+u,{
		method: 'GET',
		headers:{'apiKey': apiKey
	}
	})
	.then(response => response.text()) // Parse the response as text
	.then(async text => {
		try {
		const data = JSON.parse(text); // Try to parse the response as JSON
		if(q == 'article') {
			// data.result.unshift(data.result[0]);
			let rubricks = [];
			await getCatNames(rubricks)
			let authors = [];
			await getAuthors(authors);
			show(data,'json',q, rubricks, authors);
		} else {
			show(data,'json',q);                
		}
		} catch(err) {
			show(text,'html',q);
		}
	});  
}

Pour un fonctionement optimale, il est préferable que l'API et le site demandeur se connectent et échangent via le protocol sécurisé HTTPS.

Avec ce fichier JavaScript vient un fichier HTML d'exemple d'utilisation de l'unique fonction pour interrogé l'API et un conteneur HTML qui sert de receptacle pour l'affichage.Voici un aperçu de ce fichier :

Fichier apiCalling.html<div id="results"><!-- La liste s'affiche ici --></div>
<script>
/*/Config/*/
// Votre clé
const apiKey = 'apiPluXml';

// protocol HTTP du site (preference https (connexion sécurisé)| http non garantie )
const ProtocolHTTP = 'https';/* anything or http */

// nom du domaine de l'API suivit d'un / et d'un ? si l'url rewriting n'est pas activé sur le site OluXml distant.
const apiPluXmlSite = 'pluxthemes.com/';/*  exemple: 'pluxopolis.net/crashnewstest/' ou 'pluxthemes.com/?'   */

// nombre d'article par page
const apibypage=''; /* rien = la config du site distant */  

// afficher l'article en entier ?
let artcontent= false ; /* pour voir tout l'article : mettre a  true */
/*/End Config/*/

// Création et appel du fichier javascript distant.
let scpt = document.createElement('script');
scpt.setAttribute('id','apiCall');
scpt.setAttribute('async','');
scpt.setAttribute('src', '//'+apiPluXmlSite+'plugins/ApiPluXml/js/apiCalling.js');
document.querySelector('#results').appendChild(scpt);

  var script = document.querySelector('#apiCall');
  script.addEventListener('load', function() {
  
	////fonctions d'appels et d'affichage html
	//========================================
	//	getPlxApiResult(apiPluXmlSite+'apiPluxml') ; // aide descriptif
	//	getPlxApiResult(apiPluXmlSite+'apiPluxml&static','static') ;
		getPlxApiResult(apiPluXmlSite+'apiPluxml&article&page_number=1&bypage=5','article') ;
	//	getPlxApiResult(apiPluXmlSite+'apiPluxml&categorie','categorie') ;
	//	getPlxApiResult(apiPluXmlSite+'apiPluxml&etiquette','etiquette') ;

	////fonction d'appels , retourne un objet json
	//============================================
	//	getPlxApiResult(apiPluXmlSite+'/?apiPluxml&commentaires','commentaires') 
	//	getPlxApiResult(apiPluXmlSite+'/?apiPluxml&authors','authors')  
  });			
</script>
	

décommenter les lignes que vous voulez utiliser

Ce ne sont bien entendue que quelques exemples d'usage possibles.

Pour plus d'aide ou remonter un dysfonctionement , il ya le forum de pluxml et/ou son repo github pour y trouver la derniere version, proposer des corrections ou notifier des défauts.