Proxy d'interrogation de l'API Sitra 2 v0.1.0

Ce projet a pour objectif de rendre accessible facilement en PHP l'API d'interrogation et de recherche Sitra2. Cette API permet aux utilisateurs de Sitra de rechercher dans les objets ou d'accéder à un objet pour consulter tous les détails.

Composer a été utilisé pour décrire le projet et le rendre utilisable comme composant.

Comment m'en servir?

Installation

En utilisant composer

Il suffit de rajouter le dépôt Github dans le fichier composer.json lancer la commande suivante

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/CHStudio/sitra2-proxy"
    }
  ]
}

composer update chstudio/sitra2-proxy

Ou en inclusion directe...

<?php
require_once "[chemin vers le fichier]src/SitraApi.php";

Configuration

Tous les appels à l'API doivent être authentifiés par deux clés :

• La clé d'API fournie lors de la création du projet dans Sitra
• L'identifiant du projet

Ces informations doivent être définies pour chaque instance du proxy soit à la construction soit en utilisant la méthode configure.

<?php
$api = new SitraApi();
$api->configure("APIKEY", "PROJECTID");

//Or to use the API v1
$api = new SitraApi(SitraApi::V001);
$api->configure("APIKEY", "SITEWEBEXPORTIDV1");

Utilisation

Toutes les propriétés utilisables en recherche sont traduites en méthodes. Les valeurs passées pour chaque paramètre sont validées à travers un schéma respectant les règles définies dans la documentation Sitra.

On démarre une requête en utilisant la méthode start et on l'exécute en utilisant la méthode search. L'objet utilise une interface chainable, toutes les méthodes sont applicables très rapidement. Pour la liste complète des méthodes, ouvrez le ficher SitraApi, le schéma y est décrit.

<?php
//Récupération d'une liste de 100 objets à partir du 10ème
$results = $api
  ->start()
  ->selectionIds(["25918"])
  ->first(10)
  ->count(100)
  ->search();

Tests unitaires

PHPUnit a été utilisé pour créer les tests unitaires. Pour pouvoir les exécuter, il faut installer les dépendances composer en exécutant la commande suivante à la racine du projet :

composer install

Ensuite le ficher phpunit.xml contient déjà tous les éléments nécessaire à l'exécution et à la récupération du rapport de couverture de code. Ce rapport est généré en HTML dans un repertoire report à la racine.

Documentation

PHPDocumentor a été choisit comme outil de génération de documentation. Le fichier phpdoc.dist.xml contient déjà la configuration et le résultat est placé dans un répertoire doc à la racine.

Contribution et bugs

Vous pouvez me contacter directement pour toute question par email s.hulard@chstudio.fr ou Twitter @s_hulard.