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

Mise à jour

API de mise à jour d'une adresse de courriel d'un certificat

La modification de l'adresse de courriel associée à un certificat est possible via un appel PUT au point de terminaison [API-URL]/admin/email.

Entête HTTP obligatoire : Content-Type: application/json

Le corps de la requête est un objet JSON contenant les champs obligatoires suivants :

  • id : L'identifiant unique du certificat à mettre à jour (EvidenzId)
  • email : la nouvelle adresse de courriel
{
    "id": <EvidenzId>,
    "email": "nouvelle-adresse@domaine.com"
}

Avertissement

Cette API n'est pas utilisable sur les microcertificats ni les modèles répondant à la norme Open Badges. En effet, dans ce cas, l'adresse de courriel du destinataire fait partie intégrante des données du certificat, et ne peut être mise à jour.

API de mise à jour des Identifiants RNCP

Pour renseigner ou mettre à jour vos Identifiants RNCP (obligatoires pour permettre l'export XML vers le SI de la Caisse des Dépôts), faites un appel PUT au point de terminaison [API-URL]/issuer/config avec les paramètres suivants au format JSON :

  • idContrat : Numéro de contrat spécifique Certificateur qui vous est fourni par la Caisse des Dépôts
  • idClient : N° de la fiche client Certificateur (ou "Matricule", "fiche client" ou "BCR") qui vous est fourni par la Caisse des Dépôts
{
  "cpf": {
    "idContrat": "12345678",
    "idClient": "01234567"
  }
}
Prev
Suppressions et désactivations
Next
Gestion des modèles de certificats