soumettre / sdk-api-php
Use Soumettre.fr API from your Site
Installs: 4 039
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=5.3.0
This package is auto-updated.
Last update: 2024-05-05 02:18:10 UTC
README
# Soumettre.fr : API pour Webmasters #
Installation
- Via Git : git clone git@github.com:soumettre/sdk-api-php.git soumettre-api
- Via composer/packagist : composer require soumettre/sdk-api-php
Getting started
- Crééz un compte client gratuit sur https://soumettre.fr/.
- Installez le package dans un répertoire de votre site accessible depuis l'extérieur.
- Editez le fichier config.php à la racine du package.
- Implémentez les services.
Accès depuis notre serveur
Votre installation doit être accessible depuis notre serveur. Le package propose un type d'utilisation : toutes les requêtes vers le répertoire sont routées (via un .htaccess) vers le fichier index.php, et la classe SoumettreApi se charge de déterminer le service appelé en fonction de la route.
Implémentation des services
Etendez la classe SoumettreApi pour implémenter les 4 dernières méthodes (les "services") à votre façon. Ces méthodes, telles qu'implémentées dans la classe, sont des exemples des retours attendus.
A l'heure actuelle, ces services sont au nombre de 4 :
- check_added : Vérifie si un site est déjà présent sur votre plate-forme
- categories : Renvoie la liste de vos catégories et sous-catégories, ainsi que leurs liens de parenté
- post : Ajoute un post sur votre plate-forme
- delete : Efface un post de votre plate-forme
- check_version : Retourne la version du plugin utilisée (pour les plates-formes type Wordpress)