Documentation du web service d'articles

Présentation

Le présent service permet la recherche d'articles par nom d'auteur (partiel). Le service est interrogeable à l'URL (endpoint) indiquée ci-dessous. La réponse est au format JSON. Les paramètres de requêtes sont listés ci-dessous, ainsi que les réponses possibles en cas d'erreur.

Le service est interrogeable via Cross Origin grâce aux en-têtes HTTP CORS qui sont inclus dans la réponse.

Exemples de noms d'auteurs pour tester : Reva Ferrell, Haley, Michael, Rose, Anthony, Carson, Forbes, Mcneil, etc

Endpoint

https://ensweb.users.info.unicaen.fr/TW2/services/articles/articles.php

Paramètres GET

Trois paramètres obligatoires doivent être passés en méthode GET avec les clés suivantes :

api_key
La clé d'API est l'identifiant numérique UNICAEN de l'utilisateur
method
La seule méthode disponible pour ce service est la méthode search
auteur
La chaîne recherchée pour l'auteur

Réponses

Sauf erreur d'exécution non prévue, la répose du service est au format JSON. Elle contient une clé result qui prend la valeur error ou success selon le cas.

Messages d'erreur

En cas d'erreur, la réponse est sous la forme :

{
    "result": "error",
    "error": "Le message d'erreur de la réponse"
}

Exemple : https://ensweb.users.info.unicaen.fr/TW2/services/articles/articles.php?api_key=YOUR_API_KEY&method=zf&auteur=haley

Réponse si succès

Si tout s'est bien passé, la réponse est sous la forme :

{
    "result": "success",
    "articles": [
      {
        "publicId": "571fc236131a2ced26a6a31e",
        "title":" Article 918",
        "articleContent": "ceci est larticle 918..",
        "creator": "Haley Morgan",
        "creatorEmail": "haleymorgan@fortean.com",
        "createdAt":"2015-02-22 11:29:19"
      },
      ...
    ]
}

Exemple : https://ensweb.users.info.unicaen.fr/TW2/services/articles/articles.php?api_key=YOUR_API_KEY&method=search&auteur=haley