siraver

Spécification de l'API d'un serveur Loquicompta

Réponse en cas d'erreur

Lors de l'utilisation de l'api si la requete est invalide le retour est de la forme suivante

{
    success: false,
    code: int,
    message: "string"
}

Les codes d'erreurs sont les suivants :

• 01 : Requete invalide
• 02 : Authentification incorrect
• 03 : Utilisateur inconnu
• 04 : Jeton invalide

Points d'éntrées

GET /authentication

Indique si le serveur necessite un mot de passe pour accèder aux fichiers

// Reponse
{
    success: true,
    authentication: boolean
}

---

POST /register

Inscrit un utilisateur sur le serveur

// Requete
{
    user: "string",
    password: "string"
}
// Response
{
    success: true
}

---

POST /login

Connexion de l'utilisateur et retourne un jeton de connexion. Le jeton de connexion est valide 12h00 après son émission.

// Requete
{
    user: "string",
    password: "string"
}
// Reponse
{
    success: true,
    token: "string"
}

---

POST /token

Permet de tester la validitée d'un jeton émit lors de la connexion

// Requete
{
    user: "string" // Username
    token: "string"
}
// Reponse
{
    success: true,
    valid: boolean
}

---

POST /list

Liste les fichiers disponible pour l'utilisateur. La valeur token n'est necessaire que si l'authentification est activée.

// Requete
{
    user: "string" // Username
    token: "string"
}
// Reponse
{
    success: true,
    list: ["fileId1", "fileId2", ...]
}

---

POST /get/{file}

Récupère un fichier. Remplacer {file} par l'id du fichier à récupèrer. La valeur token n'est necessaire que si l'authentification est activée.

// Requete
{
    user: "string" // Username
    token: "string"
}
// Reponse
{
    success: true,
    fileid: "string",
    filename: "string",
    data: "string"
}

---

POST /save/{file}

Sauvegarde un fichier. Remplacer {file} par l'id du fichier à récupèrer. La valeur token n'est necessaire que si l'authentification est activée.

// Requete
{
    user: "string" // Username
    token: "string"
    data: "string" // File content
}
// Reponse
{
    success: true,
    fileid: "string",
    filename: "string"
}