Retrieve a certificate template
/products/{product_id}/certificate-templateThe certificate template has no ID of its own and is addressed through its product.
The response includes an ETag representing the current revision of the product. Send this value in the If-Match header when replacing the template to avoid overwriting a newer version. Because the revision covers the whole product, other changes to the product also produce a new ETag.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/products/string/certificate-template"{ "data": { "criteria": { "exam_id": "string", "kind": "completion", "percent": 0 }, "defaults": { "color": "string", "font": "arial" }, "enabled": true, "fields": [ { "key": "string", "label": "string", "source": "custom_field" } ], "layout": { "back_side_enabled": true, "background": "string", "fields": { "date": { "color": "string", "enabled": true, "font": "arial" }, "document": { "color": "string", "enabled": true, "font": "arial" }, "name": { "color": "string", "enabled": true, "font": "arial" }, "sequence": { "color": "string", "enabled": true, "font": "arial" } }, "qr": { "background_color": "string", "color": "string", "enabled": true, "position": "bottom-right" }, "show_dates": true, "show_product_name": true }, "object": "certificate_template", "product_id": "string", "revision": "string", "single_issue": true, "texts": { "content": "string", "instructor": "string", "workload": "string" } }}Certificates
Certificates in API v3: retrieve a certificate template, replace a certificate template, preview a certificate template, list a user's certificates, issue a certificate, retrieve a certificate, revoke a certificate, delete a certificate.
Replace a certificate template PUT
Replaces the product's certificate template. Fields omitted from the request body are reset to their default values. The certificate criteria, QR code position, and font must use one of the supported values. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version. Templates of replicated products are read-only.