doc/pages/01.administer/12.extend/06.api/admin_api.fr.md
tituspijean 3d94113e47
Add Extend YunoHost section
Co-authored-by: ljf (zamentur) <zamentur@users.noreply.github.com>
2022-08-04 19:49:10 +02:00

2.2 KiB
Raw Blame History

title template taxonomy routes
Administration depuis l'API ou une application externe docs
category
docs
default
/admin_api

Toutes les actions exécutables en ligne de commande le sont également via une API. LAPI est accessible à ladresse https://votre.serveur/yunohost/api. Pour le moment, il n'existe pas de documentation des différentes routes... mais vous pouvez trouver l'actionmap ici (en particulier les clefs api)

Avec cURL

Il faut dabord récupérer un cookie de connexion pour ensuite réaliser les actions. Voici un exemple avec cURL :

# Login (avec mot de passe admin)
curl -k -H "X-Requested-With: customscript" \
        -d "password=supersecretpassword" \
        -dump-header headers \
        https://your.server/yunohost/api/login

# Exemple de GET
curl -k -i -H "Accept: application/json" \
           -H "Content-Type: application/json" \
           -L -b headers -X GET https://your.server/yunohost/api/ROUTE \
        | grep } | python -mjson.tool

Avec une classe PHP

Pour simplifier ladministration à distance dune instance YunoHost dans le cadre dun projet CHATONS/Librehosters, des classes API ont été développées par des utilisateurs.

Par exemple, cette classe PHP vous permettra dadministrer votre instance YunoHost depuis une application PHP (site Web, outil de gestion de capacité...).

Voici un exemple de code PHP permettant dajouter un utilisateur dans votre instance YunoHost :

require("ynh_api.class.php");
$ynh = new YNH_API("adresse IP du serveur YunoHost ou nom dhôte", "mot de passe administrateur");

if ($ynh->login()) {
    $domains = $ynh->get("/domains");
    $first_domain = $domains['domains'][0];

    $arguments = array(
        'username' => 'test',
        'password' => 'yunohost', 
        'firstname' => 'Prénom',
        'lastname' => 'Nom',
        'mail' => 'test@'.$first_domain,
        'mailbox_quota' => '500M'
    );

    $user_add = $ynh->post("/users", $arguments);
    print_r($user_add);

} else {
    print("Login to YunoHost failed.\n");
    exit;
}