Certificates

See introduction to the Springest API for all our endpoint. 

Note upfront: the difference between certificates and certifications:

  • Certificates  - the actual certificate that a user gets from an institute when a training is completed. This is a filetype usually .pdf with accompanying user data. Certificates belong to Certifications.
  • Certifications - these are the certifications a product can have, for example ITIL. At the moment certifications can only be created in the Springest Admin and coupled to a product, certifications then have to be verified by Springest Employees.

Certificates:

Our Certificates API allows you to send the (pdf) certificates directly to Springest. We will process the certificates and make it available in our system for our clients/users. 

Available Methods

Method Description
GET    /users/certificates.xml?api_key=YOUR_PRIVATE_API_KEY
Get the verified certificates for matching institutes
POST /certificates.xml?api_key=YOUR_PRIVATE_API_KEY
Post certificates for matching institute

Request: POST /certificates:

Format:  "multipart/form-data"
Attributes:
  • booking_id (integer; optional)
  • certification_id (integer; required)
  • email (string; required)
  • valid_from (date; required)
  • valid_until (date; required if the certification's "requires_valid_until" is true)
  • file (file; required)

Notes for POSTing certificates:

  • Actual file sent cannot be decoded. Base64 is not allowed. We prefer filetype .pdf
  • When a certificate is received we store it in our database, it will only be visible via GET calls if the linked certification_id is verified by a Springest employee.

Example

----------

GET  /users/certificates:

Returns

  • id
  • certification_id
  • valid_from
  • valid_until
  • status
  • created_at

Example



Certifications:

Our Certification API allows you at the moment only to view certifications.

Available Methods

Method Description
GET  /certifications.xml?api_key=YOUR_PRIVATE_API_KEY Get all certifications for matching institutes

GET:  /certifications: to be able to see all verified certifications per domain.
(Note: you will need a different api_key for certifications)

Filters: 
    name
      Returns
        • id
        • name (string; required)
        • description
        • requires_valid_until

Example

For questions: contact datasupport@springest.com