WAPI - Membres mondiaux

Cet article fournit des informations sur les demandes suivantes :

• wg-members-create
• wg-members-show
• wg-members-delete

---

wg-members-create

Utiliser le wgp-members-create pour envoyer une invitation à un nouveau membre.

Paramètres

• email = adresse email du nouveau membre ou login du compte WEDOS existant - obligatoire
• policies = tableau de permissions pour tous les domaines (*) ou pour des domaines spécifiques ; les valeurs sont 1 pour lecture seule, 0 pour accès complet. Voir le modèle pour plus de détails.

Valeurs de retour

• 1000 = OK
• 2223 = format d'email invalide ou adresse inexistante
• 2274 = erreur interne - user_id manquant
• 2400 = erreur interne - code de réponse inconnu
• 2419 = invitation non trouvée
• 2420 = tableau de politique invalide
• 4000 = erreur système

Données de réponse

• email = email de réception de l'invitation
• url = adresse URL de confirmation de l'invitation
• policies_count = nombre de politiques activées (le système élimine automatiquement les domaines non valides)

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-create",
    "clTRID": "your ID",
    "data": {
      "email": "new member email (WEDOS account login)",
      "policies": {
        "domain01.tld": "0|1",
        "domain02.tld": "0|1",
        "*": "0|1"
      }
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wg-members-create",
    "data": {
      "email": "new member email (WEDOS account login)",
      "url": "invitation url",
      "policies_count": "number of successfully activated policies"
    }
  }
}

---

wg-members-show

Utiliser le wgp-members-show Le retour est un du membre URL de l'invitation.

Paramètres

• email = adresse email du membre ou login du compte WEDOS existant - obligatoire

Valeurs de retour

• 1000 = OK
• 2223 = format d'email invalide ou adresse inexistante
• 2274 = erreur interne - user_id manquant
• 2400 = erreur interne - code de réponse inconnu
• 2419 = invitation non trouvée
• 4000 = erreur système

Données de réponse

• email = email de réception de l'invitation
• url = adresse URL de confirmation de l'invitation
• policies_count = nombre de politiques activées (le système élimine automatiquement les domaines non valides)

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-show",
    "clTRID": "your ID",
    "data": {
      "email": "new member email (WEDOS account login)"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wg-members-show",
    "data": {
      "email": "new member email (WEDOS account login)",
      "url": "invitation url",
      "policies_count": "number of successfully activated policies"
    }
  }
}

---

wg-members-delete

Utiliser le wgp-members-delete pour supprimer un membre et révoquer leurs autorisations.

Paramètres

• email = adresse email du membre ou login du compte WEDOS existant - obligatoire

Valeurs de retour

• 1000 = OK
• 2223 = format d'email invalide ou adresse inexistante
• 2274 = erreur interne - user_id manquant
• 2400 = erreur interne - code de réponse inconnu
• 2419 = invitation non trouvée
• 4000 = erreur système

Données de réponse

• email = email de connexion du membre

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-delete",
    "clTRID": "your ID",
    "data": {
      "email": "member email (WEDOS account login)"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wg-members-delete",
    "data": {
      "email": "member email (WEDOS account login)"
    }
  }
}