1️⃣Commandes basiques

Cette page a pour but de donner touts les endpoints des commandes "basiques" sans utilisation d'une clé d'authentification.

Informations de l'API

Pour tester si l'api fonctionne vous pouvez utiliser cette requête GET :

https://api.maxlware.fr/v1/statuts

api.maxlware.fr/v1/statuts

L'api vous renvois cette réponse en JSON :

{
  "status": "online"
}

Si le serveur vous renvois une erreur cloudflare :

• Erreur 521 : Web server is down

• Erreur 523 : Origin is unreachable

• Erreur 1023 : Argo Tunnel error

Cela veux dire que un incident est en cours chez nos serveurs. Pensez à vérifier la page de statut.

---

Version de l'API

Pour vérifier la version de l'api, plusieurs commandes peuvent marcher.

N'hésiter pas à vérifier pour changer votre code ou projet pour marcher avec notre api.

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

api.maxlware.fr/v1/version

L'api vous renvois cette réponse en JSON :

{
  "version": "X.X",
  "message": "Build XXX"
}

---

Version des logiciels de Maxlware Developement et autre

Cela sert à vérifier la version utilisé et à télécharger si la version n'es pas la bonne.

Mxlw Browser

Mxlw Browser fonctionne à vérifier si la version du logiciel est bonne au lancement. Il va demander à l'API de donner la version. Chaque message à sa propre signification.

Vous pouvez le trouver en faisant ce lien :

https://api.maxlware.fr/v1/mxlw-browser/version

api.maxlware.fr/v1/mxlw-browser/version

L'api vous renvois cette réponse en JSON :

{
  "version": "X.X.X",
  "message": "stable" // Stable ou Beta ou Test
}

Les messages des versions peuvent changer.

Si vous n'avez pas la bonne version vous pouvez faire une requête GET :

Windows :

https://api.maxlware.fr/v1/mxlw-browser/download

api.maxlware.fr/v1/mxlw-browser/download

Le fichier est en .exe.

Apple (MacOS) :

https://api.maxlware.fr/v1/mxlw-browser/download/macos

api.maxlware.fr/v1/mxlw-browser/download/macos

Le fichier est en .dmg. Vous devez juste glisser l'application dans le dossier "Applications" et éjecter.

Linux (Ubuntu ou autre version compatible avec les .Appimage) :

https://api.maxlware.fr/v1/mxlw-browser/download/linux

api.maxlware.fr/v1/mxlw-browser/download/linux

Le fichier est en .Appimage. Vous devez le décompiler avec l'invite de commande.

---

CoMC

CoMC fonctionne à vérifier si la version du logiciel est bonne au lancement. Il va demander à l'API de donner la version. Chaque message à sa propre signification.

Vous pouvez le trouver en faisant ce lien :

https://api.maxlware.fr/v1/comc/version

api.maxlware.fr/v1/comc/version

L'api vous renvois cette réponse en JSON :

{
  "version": "X.X.X",
  "message": "stable" // Stable ou Beta ou Test
}

Les messages des versions peuvent changer.

Pour récupérer les assets Minecraft, le logiciel va demander à l'api de récupérer des informations sur la version java compatible et les liens de l'api de Mojang.

L'API va utiliser une clé ici mais pas celui pour accéder normalement. Cela va marcher en 3 étapes.

Première étape : Au premier lancement le logiciel va demander à l'API de lui créer une clé d'authentification unique pour chaque session.

https://api.maxlware.fr/v1/comc/createkey?=[CODE-DAUTH-LOGICIEL]

api.maxlware.fr/v1/comc/createkey?=[CODE-DAUTH-LOGICIEL]

L'api vous renvois cette réponse en JSON :

{
  "statut": "ok",
  "key": "XXXXX-XXXXX-XXXXX-XXXXX"
}

Deuxième étape : le logiciel va le stocker en le mettant en hash dans un fichier sécurisé ouvrable SEULEMENT par le logiciel. C'est un fichier en .mxlw.

// comc auth server
// Created XX/XX/XX - XX:XX:XX
XXXXX-XXXXX-XXXXX-XXXXX

Troisième étape : Le logiciel va lire la clé, la déchiffrer et l'envoyer à l'API. Ici, en curl.

curl -X GET "https://api.maxlware.fr/v1/comc/server" \
-H "Authorization: Bearer XXXXX-XXXXX-XXXXX-XXXXX"
-H "Content-Type: application/json"

L'api vous renvois cette réponse en JSON :

{
  "statut": "ok",
  "last-version": "X.XX.XX",
  "download-link": "https://XXXXXXXX.XXX",
  "download-link-forge": "https://XXXXXXXX.XXX",
  "download-link-fabric": "https://XXXXXXXX.XXX",
  "download-link-neoforge": "https://XXXXXXXX.XXX",
}

Normalement cette réponse ne pourra être lue en clair sur navigateur ou en curl.