Autres API

API "annuaire"

Une API est mise à votre disposition pour vous permettre de créer une page d'annuaire basée sur l'historique de vos campagnes de publication.

Conseil

Les certificats des campagnes dont les données d'historique ont été supprimées ne seront plus accessibles via cette API.

Avec cette API, vous pouvez mettre à disposition des internautes une page leur permettant de rechercher un certificat sur la base de certains attributs de ce certificat. Par exemple, un établissement d'enseignement supérieur pourra proposer une page d'annuaire où des recruteurs saisiront "nom", "prénom" et "date de naissance" d'un diplômé pour retrouver son diplôme BCdiploma, si il existe.

Attention

Cette API utilise les données d'historique utilisées pour l'émission des certificats : elle nécessite une authentification via clé d'API en lecture seule. Lors de la mise en ligne de votre page d'historique, veillez à ce que la clé d'API utilisée ne soit pas visible côté client pour éviter toute utilisation malveillante des API et des données.

Cette API d'annuaire est accessible via un appel GET à la fonction admin/data, avec les paramètres suivants :

  • campaignId : id de la campagne sur laquelle filtrer les données
  • templateId : id du modèle sur lequel filtrer les données
  • ids : EvidenzId(s) du/des certificats sur lesquels filtrer les données, passés sous forme de tableau, séparé par des "," (ex : [123456, 789456, 456798])
  • language : code ISO de la langue sur laquelle les données doivent être filtrées
  • filter : filtre sur la présence d'une chaine de caractère sur l'ensemble des données
  • n'importe quel champ du modèle de données du template (ex: firstName), avec en valeur la chaine pour laquelle filtrer les données (ex: firstName=Annie)
  • status : filtre sur le statut (1 = Validé, 3 = Supprimé, 6 - Expiré, 9 - Désactivé, 11 - En cours de publication). Si plusieurs statuts sont souhaités, il suffit de les concaténer
  • mailSent : Filtre sur le fait que le mail a été envoyé ou non (0 - Pas envoyé, 1 - Envoyé, 2 - Rejeté/Bounced, 3 - Ouvert (si le tracking est activé).
  • limit : nombre maximum d'enregistrements à retourner
  • offset : offset
  • counter : nombre maximum d'enregistrements à retourner (sans limit ni offset)
  • regex : si false, les expressions régulières sont désactivées pour les requêtes sur les placeholders (default : true)
  • startdate : ne renvoie que les attestations dont la date de génération est supérieure ou égale à startdate, format ISO YYYY-MM-DD
  • enddate : ne renvoie que les attestations dont la date de génération est inférieure ou égale à enddate, format ISO YYYY-MM-DD

Conseil

  • Pour des raisons de performance, vous devez spécifier au moins l'une des informations suivantes pour utiliser cette API : un identifiant de campagne, un identifiant de modèle, une adresse de courriel, une liste d'identifiants de certificats ou une clé de certificat. À ce titre, vous ne pouvez pas effectuer, en un seul appel API, une recherche sur l'ensemble de vos certificats.

  • La recherche est sensible à la casse, c’est-à-dire que vous n'obtiendrez de résultat que si la chaîne de caractères recherchée est strictement identique dans les données (et respecte donc les minuscules/majuscules).

    :::

API de demande d'authentification

Conseil

Cette API ne nécessite pas de jeton d'authentification

Une API est mise à votre disposition pour vous permettre de créer une page d'authentification personnalisée, en remplacement de la page d'authentification standard de BCdiploma. Lorsqu'elle est appelée, cette méthode d'API va envoyer un courriel de connexion à l'adresse spécifiée si celle-ci y est bien autorisée.

Le service "login" est accessible par un appel POST au point de terminaison [API-URL]/admin/login?email=votre_email&issuer_id=XXX où votre_email est l'adresse à laquelle envoyer le courriel de connexion et XXX votre identifiant d'émetteur.

Votre identifiant d'émetteur peut être récupéré dans le backoffice, en cliquant sur l'image d'un modèle de certificat. L'identifiant se trouve avant le & en fin d'URL. Exemple: pour le modèle https://certificate-staging.bcdiploma.com/template/2&0x13, il s'agit de 2.

En cas de réussite, l'API renverra le code 200, une erreur 404 dans le cas contraire.

API de récupéreration de la liste des modèles de courriel pour un émetteur

Cette API permet de récupérer la liste des modèles de courriel disponibles pour chaque modèle de certificat pour un émetteur. Elle est accessible via un appel GET au point de terminaison [API-URL]/mailing. Ce point de terminaison retourne toutes les associations disponibles, soit une entrée par association modèle de courriel / modèle de certificat. Si un modèle de certificat est associé à 2 modèles de courriel, il y aura donc 2 entrées.