Base de connaissances BCdiplomaBase de connaissances BCdiploma
Guide utilisateur
Guide technique
API
CGU et données
  • English
  • Français
Guide utilisateur
Guide technique
API
CGU et données
  • English
  • Français
  • API

    • Comment utiliser l'API BCdiploma
    • Automatiser le processus d'émission
    • Suppressions et désactivations
    • Mise à jour
    • Gestion des modèles de certificats
    • Gestion des parcours
    • Téléchargement
    • Exportation de données
    • Autres API
    • Gestions des erreurs

Gestion des parcours

Créer ou mettre à jour un parcours

Un parcours (pathway) est défini directement dans la configuration d'un modèle de certificat parent. Pour créer un parcours, il suffit d'ajouter une entrée meta_pathway au JSON du modèle parent, puis de le mettre à jour via un appel PUT au point de terminaison [API-URL]/issuer/:issuer/template/:template.

Conseil

La clé "key" définit le champ de jointure utilisé pour relier les certificats composant le parcours. Si elle est omise, la valeur par défaut ^Email¤ est utilisée automatiquement.

La propriété def contient la liste des modèles enfants intégrés au parcours, identifiés par leur id :

"meta_pathway": {
  "def": [
    {
      "id": "1x30"
    },
    {
      "id": "1x31"
    },
    {
      "id": "1x3A"
    }
  ]
}

Utiliser des tables de référence pour filtrer les modèles du parcours

Il est possible de conditionner l'inclusion d'un modèle enfant dans un parcours à la valeur d'un placeholder donné, à condition que ce placeholder soit une entrée d'une table de référence.

Par exemple, si la jointure doit se faire selon la valeur du placeholder ^formation¤, qui est une entrée de la table ref_formation, la syntaxe devient :

"meta_pathway": {
  "key": "^Email¤",
  "def": [
    {
      "id": "1x01",
      "formation": [
        "Australian Major Projects Leadership Academy",
        "Creativity and Design Thinking"
      ]
    },
    {
      "id": "1x02",
      "formation": [
        "Development & Marketing",
        "Digital Transformation"
      ]
    },
    {
      "id": "1x03",
      "formation": [
        "Development & Marketing",
        "Creativity and Design Thinking",
        "Catalyzing Digital Transformation"
      ]
    },
    {
      "id": "1x06",
      "formation": [
        "Catalyzing Digital Transformation",
        "Medical Statistics"
      ]
    }
  ]
}

Dans cet exemple, le modèle 1x01 sera inclus dans le parcours uniquement si la valeur du placeholder formation est Australian Major Projects Leadership Academy ou Creativity and Design Thinking.

Retirer un modèle d'un parcours

Pour retirer un modèle enfant d'un parcours, il suffit de supprimer son entrée de la liste def et de mettre à jour le modèle parent via un appel PUT au point de terminaison [API-URL]/issuer/:issuer/template/:template.

Avertissement

Lorsqu'un modèle est ajouté à un parcours en tant qu'enfant, la balise meta_pw_key lui est automatiquement attribuée. Cette balise n'est pas supprimée si le modèle est retiré du parcours, afin de ne pas invalider les certificats déjà publiés.

Prev
Gestion des modèles de certificats
Next
Téléchargement