Documentation de l'API SENAR

Cette documentation technique sera utile aux développeurs et aux personnes travaillant avec les données issues de Senar. Elle comprend des instructions sur l'authentification, l'accès aux listes d'utilisateurs et d'activités, et la création de webhooks permettant d'être notifié à l'apparition de nouvelles données.

Chaque section comporte des exemples de endpoints et de réponses JSON, pour mieux vous guider.

Authentification

Vous devez être authentifié pour pouvoir accéder aux données Senar. Pour obtenir un login et un mot de passe, contactez le support.

Endpoint

https://studio.senar.io/api/auth/login

Body: {
    username: "xxx@xxx.com",
    password: "********"
}

Réponse

Result: {
    Token: "eedx..."
}

Le token obtenu sera utilisé dans les requêtes pour vous authentifier. Le token doit être ajouté à l'en-tête de la requête pour la clé Authorization.

par ex. : Authorization: Bearer <Token>

Utilisateurs

Les utilisateurs s’enregistrent via un formulaire disponible au sein de l'application Senar.

Endpoint

https://studio.senar.io/integration/data/users

Réponse

[{
    "id": "765fc7cf-312b-469d-8508-0e943a6447c7",
    "firstName": "Jon",
    "lastName": "Doe",
    "email": "jon.doe@my.mail",
    "language": "en",
    "accountName": "ACME",
    "countryName": "USA",
    "creationDate": "2022-09-07T06:25:23.9014976",
    "profile": "Instructor"
}]

Activité

Une activité représente les données collectées lorsqu'un utilisateur a terminé un scénario.

Endpoint

https://studio.senar.io/integration/data/activities

Réponse

[{
    "id": 80119,
    "collectionId": 41,
    "userId": "b68bfbd8-8f26-427b-a3c9-2d4cec36648b",
    "traineeId": "b5e3bbbc-0c22-417a-8087-6554afe26400",
    "firstName": "Natalia",
    "lastName": "Brown",
    "company": "Daria",
    "trainingDate": "2021-03-09T17:37:11.186836",
    "scenarioId": "S01",
    "scenarioName": "Scenario 1",
    "totalPoints": 2900,
    "totalSec": 622,
    "totalTries": 1,
    "simulatorId": 18,
    "tilts": 0,
    "totalMaxPoints": 3400,
    "abandons": 1,
    "collectionTitle": "Rigging",
    "simulatorTitle": "Lifting Hardware and Sling Inspection",
    "userFirstName": "Jon",
    "userLastName": "Doe",
    "userEmail": "jon.doe@my.mail",
    "userCostCenter": "East",
    "userAccountName": "ACME",
    "traineeEmail": "guest-b45@senar.io",
    "traineeProfile": "Guest"
}]

Webhook Registration

Le webhook vous permet d'enregistrer l'adresse qui doit être notifiée lors de l'arrivée de nouvelles données. Vous pouvez vous inscrire pour recevoir les nouveaux utilisateurs ou les nouvelles activités en spécifiant le paramètre "method". L'identifiant renvoyé vous permet de vous désabonner du webhook.

Endpoint

https://studio.senar.io/integration/data/webhook_register

Request body:
{
    hookUrl: "",
    method: "activity" or "user",
    provider: "zapier"
}

Réponse

Result: {
    id: <id of the webhook>
}