Dareboost API > Package for PHP framework

Dareboost API > Package for PHP framework

Ayant réalisé un package pour l’utilisation de l’API Dareboost en PHP, je tenais à en faire un peu la promotion ici.
Pour rappel, le but d’un package est de permettre la réutilisation du code dans d’autres projets en installant juste une ligne dans composer:
composer require ynizon\dareboost-php

Pour le détail des éléments qui se trouvent à l’intérieur, suivez le guide.

Pour ceux qui se demandent comment faire, je vous recommande ce tutoriel qui explique comment faire un package avec packagist.org et que je relis très régulièrement.

Ce package se trouve sur mon github à l’adresse suivante: https://github.com/ynizon/dareboost-php
A coté de celui ci vous trouverez aussi (si besoin) un package pour accéder à l’API oncrawl et aussi un package pour l’API Search Metrics. Ok, c’est un peu des développements orientés SEO.

Le package Dareboost contient toutes les fonctions qui permettent d’aller requêter l’API Dareboost et de lui demander des analyses de sites. Tous les résultats sont renvoyés au format Json.
A noter que pour un compte simple, vous n’avez accès qu’à l’API en lecture seule, et donc pour demander une analyse, vous devrez passer en compte premium. Ensuite, à vous de faire attention à la consommation de vos crédits.

Utilisation du package:

Il y a 3 classes:

DareboostBase

C’est ce fichier qui communique avec l’API Dareboost et qui renvoie les données via curl. Si l’api passe en version supérieur à la 0.5, c’est dans ce fichier qu’il faudra faire la modification pour indiquer la nouvelle route.

DareboostAPI

C’est ce fichier qui vous servira à instancier la classe précédente. Il liste les différents appels possibles à l’API. Le nom de la méthode est souvent calqué sur la route utilisée. Les paramètres sont listés, et doivent êtres passés au travers du tableau $params. Exemple: $params = array(« url »=> »https://www.google.com »);

DareboostCustomAPI:

Vous pouvez également instancier ce fichier. La différence réside dans l’ajout de méthodes complémentaires qui me sont personnelles, mais qui vous seront peut-être utiles. Par exemple la méthode function getAnalysisReportForUrl lance une analyse, patiente et renvoie le détail de celle-ci. Cela vous évite de passer par plusieurs méthodes successives. Mais concrètement, vous pourriez faire la même chose en appelant ce dont vous avez besoin dans le fichier DareboostAPI.

Conclusion

Je n’ai malheureusement pas le temps de participer à des grands projets open source, mais quand je fais des petites contributions comme celle-ci, ca me met toujours un peu de baume au coeur. Si ca vous a été utile, n’hésitez pas à m’en faire part dans les commentaires.

 

Laisser un commentaire

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.