Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Accredible Designs API

Reusable visual specifications for rendering badges and certificates.

Accredible Designs API is one of 10 APIs that Accredible publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Designs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 7 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.accredible.com/v1, https://sandbox.api.accredible.com/v1.

10 operations 7 paths 2 schemas 1 DELETE2 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.accredible.com/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Accredible Designs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — API key sent in the Authorization header using the scheme Token token=YOURAPIKEY.

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Designs 10

Reusable visual specifications for rendering badges and certificates.

GET
/designsdeprecated
View all designs (deprecated)
listDesigns 2 params → 200401
POST
/designs
Create a design
createDesign body → 200401
GET
/designs/{design_id}
View a design
getDesign 1 param → 200404
PUT
/designs/{design_id}
Update a design
updateDesign 1 param body → 200401
DELETE
/designs/{design_id}
Delete a design
deleteDesign 1 param → 200401
POST
/designs/{design_id}/copy
Copy a design
copyDesign 1 param → 200401
POST
/designs/search
Search for designs
searchDesigns body → 200401
POST
/designs/{design_id}/preview
Preview a design
previewDesign 1 param → 200401
POST
/designers/badge/initialize
Initialize embedded badge designer
initializeBadgeDesigner → 200401
POST
/designers/certificate/initialize
Initialize embedded certificate designer
initializeCertificateDesigner → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are DesignInput (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
DesignInput
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

accredible-designs-api-openapi.yml Raw ↑

Other APIs Accredible publishes across the network.

Accredible Analytics API
Accredible Credentials API
Accredible Departments API
Accredible Evidence Items API
Accredible Groups API
Accredible Issuer API
Accredible References API
Accredible SSO API
Accredible Team Members API