Skip to content

API reference

The public API is the headers under include/crypto_service/, in namespace crypto_service; crypto_service/crypto_service.hpp includes them all. Doxygen renders them from their comments:

Open the API reference

Header Types Role
async_client.hpp AsyncClient The primary client: every operation returns a std::future; thread-safe
client.hpp Client, RawRequest, RawResponse The blocking client, and request() for routes without a typed method
operations.hpp Operations One method per operation, shared by both clients (ADR 0004)
options.hpp ClientOptions, RetryOptions, CallOptions, CancelSource, CancelToken, describe() Base URL, credentials, timeout, deadline, retries, traceparent, cancellation
errors.hpp Error, ApiError, TransportError, CancelledError, Problem, FieldError What the methods throw (ADR 0003)
encoding.hpp Bytes, to_hex, from_hex, to_base64, from_base64, to_bytes Binary values and the API's two text encodings
transport.hpp Transport, AsyncTransport, HttpRequest, HttpResponse, make_curl_transport(), make_curl_multi_transport() The HTTP seam, for another stack or a test double
models/*.hpp Request and result structs Service, hashing and MAC, symmetric, keys and signing, asymmetric and post-quantum, KMS and OPAQUE
version.hpp (generated) kSdkVersion The SDK version, from CMakeLists.txt

Method names follow the TypeScript reference SDK where it has them (hash, encrypt, sign, ml_kem_encapsulate, ...) and are derived from the OpenAPI operationId otherwise, in snake case.

The reference is generated by make docs (Doxygen, then MkDocs) and built with warnings as errors, so an undocumented public member fails the build.