🔰Premiers pas

Bienvenue sur la documentation de l'API Maxlware. Ici vous trouverez toutes les informations correspondant à l'api.

Base URL

api.maxlware.fr/v1

http://api.maxlware.fr/v1

---

Tester l'api

Voir si l'api est en ligne :

api.maxlware.fr/v1/statut

http://api.maxlware.fr/v1/statut

---

Voir la version de l'api :

api.maxlware.fr/v1/version

http://api.maxlware.fr/v1/version

Cela peut vous servir pour savoir la bonne version et ne pas mettre de mauvais enpoints.

---

Avoir une clé API

Certaines URL ont besoin d'une clé API. Voici les étapes pour en créer une :

• Étape 1 : Aller sur le site maxlware.fr/api

• Étape 2 : Cliquer sur "créer une nouvelle clé"

• Étape 3 : Entrer votre nom / prénom / Email / Le nom de votre organisation / Votre site.

• Étape 4 : Regarder vos mails pour voir votre clé API.

Si vous n'avez pas reçu, merci d'attendre 15 minutes sinon contacter le support.

---

Utilisation de la clé API

Les utilisations de la clé API est variés, suivez les consignes sur les commandes que vous pouvez utiliser.

Voici le code pour vérifier votre clé si elle est active : (exemple)

curl http://api.maxlware.fr/v1/id/checkkey
    -H "X-API-Key: 000000000000000"

Réponse : (exemple)

{
  "valid": true,
  "plan": basic,
  "owner": "[email protected]"
}

---

Sanctions

Votre clé peut être bloqué si vous faisait trop de requête en un lapse de temps. Vous recevrez un mail si vous avez été bloqué.