8. API

nChain Certify offers an API endpoint for users, allowing them to issue certificates programmatically through their own application.

Using the following API endpoint, users can issue certificates programmatically:

[POST] https://certificates.nchain.cloud/api/public/api/v1/issue-additional-attendees

API Request Headers

In the headers of their API request, users will need to specify their API key.

To generate an API key, log into your Certify dashboard and navigate to your user profile on the top right-hand corner of the screen.

Then, click on "API Key"

You will then be prompted to generate an API key.

You will need to specify it in the header of your API request, according to the following format:

x-api-key: 1a2b3c4d5e6f...

API Request Body

You will need to specify two parameters inside the body of your request: campaignId and attendees

campaignId: this is the identifier for the campaign that you wish to issue certificates from.

Note: for creating certificates from the API, you will first need to create a campaign from your dashboard. All certificates sent from the API for this campaign will use the same design and certificate details (name of course, issuer name and location)

Where to find the campaign ID, necessary to include inside your API request parameters

attendees: this second parameter serves to list the new people that you wish to issue certificates for. For each new attendee, specify their name, email and title (optional).

Example of request body:

{
    "campaignId": "937b8560-db22-4a1b-b4c5-9a6d2fe51e30",
    "attendees": [
        {"name": "John Doe", "email": "[e-mail]", "title": "Student"},
        {"name": "Ben Smith", "email": "[e-mail]", "title": "Exceptional distinction"}
        ]
}