Générer une url

Pour générer une url embed, vous devez faire un POST en passant bien votre clé d'API en Bearer Token.

Pensez aussi à bien ajouter votre ID tenant dans le header X-Tenant.

Générer une url embed

POST https://api.cards-microlearning.com/v1/embeds

Headers

Name	Valeur
Content-Type	application/json
Authorization	Bearer <token API>
X-Tenant*	‹Identifiant de votre espace (Tenant)>

Request Body

Name	Type	Description
type*	String	Type d'url à générer. Peut-être : - training - trainings
training_id	Uuid	L'ID de la formation a afficher (requis si le "type" est "training").
email*	Email	L'adresse mail de l'apprenant pour qui afficher la ou les formations.
once	Boolean	Pour dire si l'url est à usage unique. (Default true)
expires_at	Date	Date d'expiration de l'url embed. Format : yyyy-mm-dd (ex : 2024-09-25)

200: OK Retourne une réponse en JSON contenant l'url.

{
    "message": "Embed link created",
    "url": "https://embed.cards-microlearning.com/xxxxxxxxxx"
}

400: Bad Request Retourne les infos dans un JSON

Exemples si un champ est mal renseigné :

{
  "message": "The training id field is required when type is training.",
  "errors": {
    "training_id": [
      "The training id field is required when type is training."
    ]
  }
}

Exemple si l'apprenant n'existe pas :

{
  "message": "User doesn't exist"
}