Miscellaneous APIs

"Directory" API

An API is available to allow you to create a directory page based on the history of your publication campaigns.

Tips

Certificates from campaigns whose history data has been deleted will no longer be accessible via this API.

With this API, you can provide a web page for users to search for a certificate based on specific certificate attributes. For example, an institution of higher education will be able to offer a directory page where recruiters will enter "last name", "first name" and "date of birth" of a graduate to find his BCdiploma diploma, if it exists.

Caution

This API uses the history data used to issue certificates and requires read-only API key authentication. When publishing your directory web page, make sure that the API key used is not visible on the client side to prevent malicious use of APIs and data.

This directory API is accessible via a GET call to the admin/data function, whose parameters are listed here:

  • campaignId: id of campaign to filter data on
  • templateId: id of template to filter data on
  • ids: EvidenzId(s) of the certificate(s) on which to filter the data, passed in the form of an array, separated by "," (e.g.: [123456, 789456, 456798])
  • language: ISO code of the language to filter data on
  • filter: filters based on the presence of a string across all data fields
  • any field from the template’s data model (e.g., firstName), with the value set to the string you want to filter the data on (e.g., firstName=Annie)
  • status: status filter (1 = Validated, 3 = Deleted, 6 = Expired, 9 = Disabled, 11 = Minting). If multiple statuses are needed simply concat them in an arry, e.g. status=[1,3,6].
  • mailSent: Filter on either the mail has been sent or not (0 - Not sent, 1 - Sent, 2 - Rejected/bounced, Opened (if tracking is activated))
  • limit: max number of record to return
  • offset: offset
  • counter: total number of record to return (without limit and offset)
  • regex: if false, regular expressions are disabled for queries on placeholders (default : true)
  • startdate: returns only the attestations whose generation date is greater than or equal to startdate, in ISO format YYYY-MM-DD
  • enddate: returns only the attestations whose generation date is less than or equal to enddate, in ISO format YYYY-MM-DD

Tips

  • For performance reasons, you must specify at least one of the following pieces of information to use this API: a campaign ID, a template ID, an email address, a list of certificate IDs, or a certificate key. As a result, you cannot search across all of your certificates in a single API call.
  • The search is case-sensitive, meaning you will only get results if the searched string matches the data exactly (including lowercase/uppercase).

Authentication request API

Tips

This API does not require an authentication token

An API is provided to allow you to create a custom authentication page, replacing the standard BCdiploma authentication page. When called, this API method will send a login email to the specified email address if it is authorized.

The "login" service is accessible by a POST call to the [API-URL]/admin/login?email=votre_email&issuer_id=XXX endpoint, where your_email is the email address to send the login email to and XXX is your issuer ID.

Your issuer ID can be retrieved in the backoffice, by clicking on the image of a certificate template. The issuer ID is found before the & at the end of the URL. Example: for the template https://certificate-staging.bcdiploma.com/template/2&0x13, it is 2.

In case of success, the API will return the code 200, otherwise a 404 error.

List of email templates for an issuer API

This API allows you to retrieve the list of email templates available for each certificate template for an issuer. It is accessible via a GET call to the [API-URL]/mailing endpoint. This endpoint returns all available associations, one entry per email template/certificate template association. If a certificate template is associated with 2 email templates, there will be 2 entries.