getList

Requête

Permet de récupérer la liste de tous les entrées en shiKomori. La réponse est retournée dans un array de string.

Endpoint

[Domain]/academy/api/v1/Dictionary/getList

Exemple

Javascript

const endpoint = "[endpoint]";
const apiKey = "[myAPIKey]";

// Use the username and password to obtain data based on user rights
const username = "[username]"; // optionnel
const password = "[password]"; // optionnel

fetch(endpoint, {
    method: "POST", 
    headers: {
        "Authorization": apiKey,
        "username ": username,
        "password ": password 
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Erreur :", error));

Second Tab

Réponse

{
    "Dictionary": {
        "version": 1,
        "authorization": "all",
        "endValidity": "2022-01-06",
        "variety": "shiKomori",
        "entries": "11554/11554",
        "list": [
            "aɓiria",
            "aɓuyati",
            "adhan",
            "adjaɓu",
            "adjali",
            "âdui",
            "âɗa",
            "na",
            "mila",
            "aɗaɓu",
            "nfu",
            "afa",
            "âfia",
            "Afrika",
            "Ya",
            "Kusini",
            "âfu",
            "alahulia",
            "alakini",
            "alama",
            "alifu",
            "alifuɓe",
            "alikoli",
            "Araɓu",
            "mia",
            "arɓaini",
            ...
        ]
    }
}

Avec une authorization de démo, cette requête ne renvoie qu'un nombre limité de mots. Le nombre de mots du dictionnaire est inscrits dans le champ entries. Vous pouvez vous servir des champs authorization et entries pour en informer l'utilisateur.

Description des champs

Champ	Type	Description	Valeur
Dictionary	Dictionary	Objet dictionnaire
list	array	Liste de mots