API Définitions

Cet objet représente les définitions du site Le Temps.

Endpoints disponibles

Recherche de définitions
Détail d’une définition

Recherche de définitions

URL : https://www.letemps.ch/api/definitions
Type d’appel : GET

Paramètre	Type	Obligatoire	Commentaire	Exemple
sirius_id	`string`	Non		c3RnLWxldGVtcHM6QXJ0aWNsZTo3ODg2MA
title	`string`	Non	La chaîne qu’on va chercher dans les titres ou les alias des définitions	Lorem ipsum

Exemple d'appel

https://www.letemps.ch/api/definitions?sirius_id=c3RnLWxldGVtcHM6QXJ0aWNsZTo3ODg2MA

⚠️

La recherche doit contenir l’un au moins de ces paramètres, sinon elle renverra un message d’erreur
Le critères de recherche sont cumulables, si vous précisez un sirius_id ET un titre la recherche filtrera sur ces deux critères.

L’appel renvoie un statut 200 à partir du moment où la recherche s’effectue correctement, même si elle ne trouve pas de résultats. Il renvoie un statut 400 si aucun paramètre de recherche valable n’a été trouvé.
Si la requête est valable il renvoie également un tableau definitions contenant les objets trouvés, sinon il renvoie un code d’erreur.

Réponse correcte

{
    "definitions": [
        {
            "id": 123456,
            "sirius_id": "c3RnLWxldGVtcHM6QXJ0aWNsZTo3ODg2MA",
            "title": "Lorem ipsum dolor",
            "aliases": [
              "LID",
              "L.I.D."
            ]
        },
        {...}
    ]
}

Réponse erronnée

{
    "code": "no_param"
}

Détail d’une définition

URL : https://www.letemps.ch/api/definitions/:id
Type d’appel : GET

Paramètre	Type	Obligatoire	Exemple
id (dans l’url directement)	`integer`	Oui	123456

Exemple d'appel

https://www.letemps.ch/api/definitions/123456

L’appel renvoie un statut 200 si la définition a bien été trouvée, ou un statut 404 en cas d’échec.
Si la définition a été trouvée il renvoie également un objet definition, sinon il renvoie un code d’erreur.

Réponse correcte

{
    "definition": {
        "id": 123456,
        "sirius_id": "c3RnLWxldGVtcHM6QXJ0aWNsZTo3ODg2MA",
        "title": "Lorem ipsum",
        "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
        "aliases": [
          "LID",
          "L.I.D."
        ]
    }
}

Réponse erronnée

{
    "code": "not_found"
}