API Publiques
API PUBLIQUES MDR SERVICES
Voici la liste et le détail du fonctionnement des premières API publiques publiées par MDR Services. Elles sont pour le moment en lecture seule et permettent d’obtenir les informations suivantes :
AUTH :
- Liste des domaines/hébergements auxquels l’utilisateur a le droit d’accéder
- Informations générales sur l’hébergement (Tableau de bord)
WEB :
- détail d’un hébergement et de la configuration de son virtualhost
- Liste des sauvegardes
MAIL :
- Liste des comptes mails d’un hébergement
- Détail de chaque compte mail
DNS :
- Liste des entrées DNS d’un hébergement
Qu’est ce qu’une API ? Une API, ou Interface de Programmation Applicative, permet à différentes applications informatiques de communiquer entre elles, en définissant les règles pour l’échange de données et de fonctionnalités. Cela facilite l’intégration de services et la création d’interactions entre divers systèmes.
Les appels se font systématique sur le modèle suivant :
URL : https://api.au12.info/<version-de-l’API>/<nom de l’endpoint>
Arguments (POST) :
- login : adresse mail du compte administrateur autorisé à consulter les API
- pass : mot de passe du compte
La version actuellement utilisée est la version 4.0
Les API sont fournies en l’état, des modifications peuvent être effectuées sans préavis.
Ces API donnent la liste des hébergements auquel le compte a accès, ainsi que des informations générales sur un hébergement donné.
DOMAINES
URL : https://api.au12.info/v4/domaines.php
Méthode : POST
login : adresse mail du compte administrateur
pass : mot de passe du compte administrateur
resultcount : nombre de domaines
results [
id : numéro unique identifiant l’hébergement
site : URL de l’hébergement
type : 0 si domaine principal de l’hébergement, 2 si alias
]
TABLEAU DE BORD
URL : https://admin2.au12.info/tableaudebord.php
Méthode : POST
login : adresse mail du compte administrateur
pass : mot de passe du compte administrateur
domaine : Identifiant du domaine à consulter
nbmail : nombre de comptes mails inclus avec l’hébergement
espaceweb : quota disque de l’hébergement
quota : espace disque effectivement utilisé
bandepassante : bande passante consommée durant le mois en cours (en Mo)
pack : nom commercial du pack d’hébergement
site : URL du site
serveur : nom du serveur web surlequel se trouve l’hébergement
type : type d’hébergement (0 : hébergement principal du pack / 2 : alias)
datecreation : date de création de l’hébergement
droits : droits de l’utilisateur sur le pack
origine : dans le cas d’un alias, identifiant de l’hébergement d’origine du pack
serveur mail : nom du serveur de messagerie du pack
bpautorise : quota mensuel de bande passante autorisé par l’hébergement (en Mo)
actdns : ON si les serveurs DNS sont activés pour cet hébergement, OFF sinon
score_wpt : Score TTFB
score_lh : Score GooglePageSpeed
score_alyze : Score SEO
score_security : Score serveurs
webscore : note du webscore
nbmailutilise : nom de comptes mails utilisés par l’hébergement
php : version de PHP utilisé par l’hébergement
webpagetest : indique si le webscore doit être calculé pour cet hébergement
Ces API donnent accès à la configuration des virtualhost et la gestion des sauvegardes web.
WEB
URL : https://api.au12.info/v4/web.php
Méthode : POST
login : adresse mail du compte administrateur
pass : mot de passe du compte administrateur
domaineid : Identifiant du domaine à consulter
droits : si « readonly », l’utilisateur n’ pas le droit de modifier les données
quota : espace disque utilisé (en Mo)
espaceweb : espace disque autorisé (en Mo)
serveur : nom du serveur surlequel se trouve l’hébergement
php : version php maximale du serveur
histobackup : 0 si le service de backup est activé
apachessl : certificat SSL activé
ssltype : type de certificat SSL
sslfin : date de validité du certificat SSL
sanswww : ON si le site n’est pas accessible en www.URL
actweb6 : 1 si ipv6 activé / 0 si ipv6 désactivé
sslonly : Certificat SSL forcé
login : identifiant FTP
operation_en_cours : 1 si une modification des paramètres est en cours, 0 sinon
actssh : accès SSH / SFTP activé
xmlrpc : 1 si les requêtes sur les fichiers xmlrpc.php sont bloquées / 0 sinon
web : 1 s’il s’agit de l’URL principale de l’hébergement
versionphp : version de php utilisée par le site
phpfpm : 1 si le serveur utilise PHP FPM
vphp1-6 : versions de php disponibles sur le serveur
webscore : si > 0 indique à quel jour de la semaine le site est testé
varnish : 1 si varnish est activé / 0 sinon
matomo : 1 si Matomo est activé / 0 sinon
matomotoken : token Matomo (s’il est activé)
matomositeid : id Matomo du site (s’il est activé)
externemysql : 1 si mysql est accessible de l’extérieur du serveur / 0 sinon
snvmax : nombre de sauvegardes
loginssh : identifiant SSH / SFTP
repertoiressh : répertoire de base pour SSH
loginsql : identifiant SQL
serveurmysql : serveur mysql
repertoire : répertoire de base de l’hébergement
repertoireapache : répertoire du virtualhost apache
mailing : 1 si l’envoi de mail est désactivé pour cet hébergement / 0 sinon
bpautorise : Traffic mensuel en Mo autorisé
quotastorage : espace disque utilisé par les sauvegardes
queltype : type de pack
quelpack : nom commercial du pack d’hébergement
limitestorage : limite d’espace disque pour la sauvegarde (en Mo)
alias [
id : identifiant de l’alias
nom : nom de l’alias
type : type d’alias
]
basessql : [
id : id de la base
nom : nom de la base de données + espace disque utilisé
]
SAUVEGARDES
URL : https://admin2.au12.info/auth_backweb_app.php
Méthode : POST
login : adresse mail du compte administrateur
pass : mot de passe du compte administrateur
domaine : Identifiant du domaine à consulter
diff : différentiel avec la sauvegarde précédente
results [
numero : identifiant de la sauvegarde
date : date de la sauvegarde
]
Ces API donnent accès à la liste des comptes mails d’un hébergement ainsi qu’aux détails de chaque compte.
URL : https://api.au12.info/v4/mail.php
Méthode : POST
login : adresse mail du compte administrateur
pass : mot de passe du compte administrateur
domaineid : Identifiant du domaine à consulter
droits : si « readonly », l’utilisateur n’ pas le droit de modifier les données
queltype : 0 si domaine principal, 0 si alias
nb_adresses : nombre de comptes mails autoriés
gateway : 1 si gateway antispam activée, 0 sinon
mailssl : 1 si SSL activé pour l’accès webmail/pop/imap/smtp, 0 sinon
nbmailalias :
nbmailstotal : nombre de comptes mails gérés par cet utilisateur
resultcount : nombre de comptes mails pour le domaine en cours
results [
id : identifiant du compte mail
login : nom du compte mail
taille_boite : quota du compte mail (en Mo)
utilise : usage de la boite mail (en Mo)
etat : 0 si active / 1 si désactivée / 2 si bloquée
u_forwardto : envoie d’une copie des mails entrants
u_remoteaddress : transfert des mails entrants
operation : <> 0 si une opération est en cours sur le compte mail
]
DETAIL COMPTE MAIL
URL : https://api.au12.info/v4/detailmail.php
Méthode : POST
login : adresse mail du compte administrateur
pass : mot de passe du compte administrateur
domaineid : Identifiant du domaine à consulter
adresseid : Identifiant du compte mail à consulter
login : identifiant du compte mail
grade : droits du compte mail (0 : simple utilisateur, 1: administrateur)
droits : si « readonly », l’utilisateur n’ pas le droit de modifier les données
alias : alias du compte mail
full_name : Nom complet du compte
spamstop : 1 si l’antispam est activé
groupware : 1 si les calendriers/porte document sont activés
taille_boite : Quota de la boite mail
utilise : Espace disque utilisé par la boite mail
u_accountdisabled : 1 si le compte est désactivé, 0 sinon
u_forwardto : envoi d’une copie des mails entrants
u_remoteaddress : transfert inconditionnel des mails entrants
u_inactivefor : durée de conservation des mails (0 si infini)
zimbrapartage : 1 si les partages sont activés
queldomaine : domaine du compte mail
domaine : identifiant du domaine du compte mail
serveurmail: nom du serveur de messagerie sur lequel le compte est installé
zimbraPasswordLockoutEnabled : 1 si la détection d’intrusions du compte mail est activée
pop3 : 1 si l’accès POP est activé
imap : 1 si l’accès IMAP est activé
sasl : 1 si l’accès SASL est activé
webmail : 1 si l’accès Webmail est activé
nextcloud : 1 si l’accès Nextcloud est activé
nc_pass : mot de passe nextcloud
nc_host : hôte Nextcloud
nc_quota : Quota Nextcloud
nc_usage : Espace disque Nextcloud utilisé
nc_lastlogin : Dernière connexion Nextcloud
Ces API donnent accès à la configuration DNS d’un hébergement et à la liste des entrées
DNS
URL : https://api.au12.info/v4/dns.php
Méthode : POST
login : adresse mail du compte administrateur
pass : mot de passe du compte administrateur
domaineid : Identifiant du domaine à consulter
actons : ON si la gestion des DNS est activée
idspf : Id de l’entrée SPF
valeurspf : Détail de l’entrée SPF
dnsnumserie : Numéro de série des DNS
dnsttl : Valeur TTL utilisée
operation_en_cours : 1 si une modification est en cours d’application
dns1 : serveur DNS primaire
dns2 : serveur DNS secondaire
dns3 : 3eme serveur DNS (si applicable)
dnssec : 1 si DNSSEC est activé
droits : si « readonly », l’utilisateur n’ pas le droit de modifier les données
resultcount : nombre d’entrées DNS
results [
id : id de l’entrée DNS
nom : nom de l’entrée
type : type d’entrée
valeur : valeur de l’entrée
]