Teachizy - Documentation APIs REST

Appearance

Documentation ​

Introduction ​

Ceci est une documentation concernant toutes les APIs REST publiques disponibles sur Teachizy.

URL racine de l'API REST ​

https://api.teachizy.fr/api/v1

Authentification sur l'API REST ​

L'authentification passe par une clé d'API générée sur votre compte app.teachizy.fr

Le header HTTP de chaque requête doit contenir la clé suivante :

Authorization: Bearer <token>

Endpoints ​

Voici la liste des enpoints disponibles

Lister les formations ​

Requête

GET /externals/automations/trainings

Exemple de réponse

json
{
  "data": [
    {
      "uuid": "xxxx-xxxx-xxxx-xxxx",
      "name": "nom d'une formation",
      "created_at": "2021-01-01 20:00:00" /* UTC */
    }
  ]
}

Lister les leçons ​

INFO

Les leçons de type chapitre ont des sous leçons dans une clé children.
Il n'y a qu'un niveau de children.

Requête

GET /externals/automations/trainings/{uuid}/items

Paramètres

  • uuid : C'est l'UUID de la formation

Exemple de réponse

json
{
  "data": [
    {
      "id": "xx",
      "order": 1,
      "name": "nom d'une leçon",
      "type": "GENERIC", /* GENERIC, SECTION, QUIZ or TASKS */
    },
    {
      "id": "xx",
      "order": 2,
      "name": "nom d'un chapitre",
      "type": "SECTION", /* GENERIC, SECTION, QUIZ or TASKS */
      "children": [
        {
          "id": "xx",
          "order": 1,
          "name": "nom d'une sous leçon",
          "type": "GENERIC", /* GENERIC, SECTION, QUIZ or TASKS */
        }
      ]
    }
  ]
}

Infos du Store ​

Requête

GET /externals/automations/store

Exemple de réponse

json
{
    "data": {
        "uuid": "xx-xx-xx-xx-xx",
        "name": "Nom de l'espace de formation",
        "description": "desc",
        "logo": "http://api.teachizy.fr/storage/xxx/xxx/xxx.png", /* ou null */
        "favicon": "http://api.teachizy.fr/storage/xxx/xxx/xxx.png", /* ou null */
        "created_at": "2021-01-01 20:00:00" /* UTC */
    }
}

Inviter un apprenant ​

Requête

POST /externals/automations/customers
json
{
  "firstname": "un prénom",
  "lastname": "un nom",
  "email": "un email",
  "training_uuids": ["uuid", "uuid", ... ]
}

Réponses

Tout s'est bien passé
HTTP 200
Erreur de validation
HTTP 422

Bloquer un apprenant ​

Requête

POST /externals/blocked-customers
json
{
  "email": "email de l'apprenant",
  "training_uuids": ["uuid", "uuid", ... ]
}

Réponses

Tout s'est bien passé
HTTP 200
Erreur de validation
HTTP 422

Débloquer un apprenant ​

Requête

POST /externals/unblocked-customers
json
{
  "email": "email de l'apprenant",
  "training_uuids": ["uuid", "uuid", ... ]
}

Réponses

Tout s'est bien passé
HTTP 200
Erreur de validation
HTTP 422