doc/admin_api_fr.md

43 lines
1.7 KiB
Markdown
Raw Normal View History

2017-02-05 06:41:50 +01:00
# Administration depuis lAPI ou une application externe
2017-02-05 06:41:50 +01:00
Toutes les actions exécutables en ligne de commande le sont également via une API.
2017-02-05 06:41:50 +01:00
LAPI utilise ladresse https://VOTRESERVEUR/yunohost/api et toutes les actions sont détaillées sur cette page.
2017-02-05 06:41:50 +01:00
Il faut dabord récupérer un cookie de connexion pour ensuite réaliser les actions. Voici un exemple via curl :
```bash
Login (avec mot de passe admin): curl -k -d “password=XXX” dump-header headers https://VOTRESERVEUR/yunohost/api/login
GET: curl -k -i -H “Accept: application/json” -H “Content-Type: application/json” -L -b headers -X GET https://VOTRESERVEUR/yunohost/api/ROUTE | grep }| python -mjson.tool
```
2017-02-05 06:41:50 +01:00
Pour simplifier ladministration à distance dune instance YunoHost dans le cadre dun projet CHATONS, des classes API ont été développées par des utilisateurs.
2017-02-05 06:41:50 +01:00
Par exemple, cette classe PHP vous permettra dadministrer votre instance YunoHost depuis une application PHP (site web, outil de gestion de capacité…).
2017-02-05 06:41:50 +01:00
Voici un exemple de code PHP permettant dajouter un utilisateur dans votre instance YunoHost :
```bash
require("ynh_api.class.php");
2017-02-05 06:41:50 +01:00
$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',
2017-02-05 06:41:50 +01:00
'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;
}
```