Comment ajouter des employés à Plecto via API

Requête POST pour créer des membres dans Plecto

{
    "updating_api_provider_id": "API Provider ID",
    "updating_api_provider": "MY API",
    "updating_api_provider_email": "api.email@example.com",
    "name": "John Doe",
    "is_active": true,
    "teams": [101010]
}

Endpoint: https://app.plecto.com/api/v2/members/

POST une requête comme montré dans l'exemple ci-dessus. Cette requête contient les clés minimales pour créer un utilisateur (membre/employé) dans Plecto sans accès de connexion.

Voici une répartition de chacune des clés :

• "updating_api_provider_id": "ID du fournisseur API"

  • Cela sera affiché comme l'ID externe dans le profil de l'employé. Une fois envoyé, vous ne pourrez pas écraser ce nom.

• "updating_api_provider": "MON API"

  • Cela sera le nom du système, également connu sous le nom de fournisseur de données. Si vous mettez à jour cette clé et envoyez une nouvelle requête tout en gardant les autres clés identiques, le profil de l'employé dans Plecto ajoutera un nouveau fournisseur de données à la liste.

• "updating_api_provider_email": "api.email@example.com"

  • C'est l'email de l'utilisateur. Une fois envoyé, il n'est pas possible d'écraser l'email (par exemple, si vous mettez à jour l'email à api.email_new@exaple.com).

• "name": "John Doe"

  • C'est le nom de l'utilisateur. Plusieurs noms sont automatiquement séparés en champs prénom et nom de famille. Vous pouvez facilement l'écraser.

• "is_active": true

  • Pour désactiver un utilisateur, définissez cette clé sur false.

• "teams": []

  • C'est une clé obligatoire, mais vous pouvez la laisser vide. Si vous souhaitez spécifier des équipes, consultez l'endpoint https://app.plecto.com/api/v2/teams/ et ajoutez les ID de vos équipes. Pour plusieurs équipes, séparez-les par une virgule.

Vous pouvez ajouter d'autres clés non obligatoires (vous verrez une liste de clés dans la réponse de la requête, mais seules les clés énumérées ci-dessous vous permettent d'écrire) :

• "title": "Spécialiste API Senior"

• "display_name": "Présentateur"

• "manager": "e1c111ebbc1111be1cbb1c111ced1111"

• "managed_teams": []

Comment inviter des employés à Plecto via API

{
    "name": "John Doe",
    "teams": [],
    "email": "john@doe.com",
    "create_login": true
}

Dans l'étape précédente, nous avons montré comment créer un employé sans accès de connexion. Ici, vous voyez un exemple de requête si vous souhaitez inviter un employé à Plecto.

POST: https://app.plecto.com/api/v2/members/