Aide du plugin ApiPluXml

aide redigé

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

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.

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

Pour obtenir des données de configuration au format json:(données sensibles filtrées)

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

Pour obtenir les données des Auteurs au format json:(données sensibles filtrées)

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

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

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/*/Config/*/
const apiKey = 'apiPluXml'; // Dans le futur, ce sera votre clé personnel à demander au responsable du site duquel vous souhaitez utiliser les ressources.
const ProtocolHTTP = 'https';/* anything or http */
const apiPluXmlSite = 'pluxopolis.net/crashnewstest';/* pluxml site domain name  where to fetch datas examples: [pluxopolis.net/crashnewstest] (without brackets)   */
const apibypage=''; /* default value is 5*/  
let artcontent= false ; /* afficher uniquement le chapo des articles distants | pour voir tout l'article : mettre à true */
/*/End Config/*/

Pour un fonctionement optimale, il est necessaire que le site sollicité 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<script>
////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>
<div id="results"><!-- La requête s'affiche ici --></div>  
    

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 dernière version, proposer des corrections ou notifier des défauts.