CertHub APIs
CertHub exposes multiple backend APIs that let you move data in and out of the system of record. The most common integration pattern is software teams that maintain the top of the V-model in CertHub and need to connect it to their engineering environment.
New to CertHub?
The APIs use products, knowledge units (KUs), knowledge topics (KTs), records, and Tracer links. Read these product docs first if the terms are new:
- Core Concepts covers data versus documents, Product, and Tracer.
- Entering Product Data covers knowledge units and knowledge topics in the Product Database.
- Use Cases shows how CertHub pre-configures links between related data.
- Requirements Management is the Requirements Engineering use case (UREQ → SYSREQ → CREQ → UNITREQ → DOUT → VERIF / VALID).
Cadence is CertHub’s public engineering example. It syncs those seven Requirements Engineering knowledge topics, plus a Release Record KT for write-back. For history versus revision IDs in API calls, see IDs and relationships.
What the APIs are for
| API | Purpose | Typical use |
|---|---|---|
| Tech Doc API | Products, knowledge units (KUs), knowledge topics (KTs), and their schemas | Read product structure, get KT field definitions, resolve certhub-key mappings |
| Records API | Create, read, and update individual records within a KT | Export requirements, write evidence records back |
| Tracer API | Traceability nodes, edges, and batch operations | Retrieve links between records, for example system requirement to verification |
| Document API | Document histories and revisions | Work with rendered documents |
Each API remains an independent service with its own base URL and OpenAPI specification.
How this portal is organized
Use the API section in this order:
- Overview to understand which API fits your use case
- Get started for authentication, base URLs, and your first request
- Concepts for the details that usually trip integrations up
- Guides for end-to-end workflows
- API Reference for the generated endpoint documentation
SDKs and client libraries
There is no official CertHub SDK yet. In the meantime, use any HTTP client you prefer, such as Python requests, JavaScript fetch, curl, or a generated client based on the published OpenAPI files.
Cadence is CertHub’s public engineering example. It implements export, tracer, and release write-back using the API; useblocks (Sphinx-Needs / CodeLinks / Test-Reports) is the optional last-hop toolchain in that repo, not a CertHub requirement. See Working example or watch the walkthrough.