Try ANKASecureΒ© β Interactive API Documentation
The ANKASecureΒ© Developer Hub is the single, live source of truth for every API call you can make against the platform. It is built around an interactive playground, end-to-end recipes, and an always-current reference, so you can move from "first request" to "production integration" without leaving the browser.
π Open the Developer Hub π API Reference π³ Recipes
Three ways to explore
The Developer Hub is structured so each persona can land on the entry point that fits their workflow.
Getting Started β first request in under 10 minutes
The Getting Started guide walks you through authenticating, obtaining a JWT, and making your first cryptographic call. It is the recommended entry point for every new integrator. You'll see how it works, how to authenticate, what the API surface covers, the four-step quick start, the supported key types, the SDK and CLI for non-HTTP clients, the RFC 7807 error model, multi-tenant isolation, and per-environment URLs.
Recipes β composed workflows you can copy
Recipes are end-to-end flows that combine multiple endpoints to solve a complete use case. Instead of reading a per-endpoint reference and guessing how to chain calls, you start from a finished workflow (encrypt-then-sign, RSA β ML-KEM migration, key rotation with re-encryption, composite hybrid key generation, etc.) and adapt it to your data. Every recipe is runnable.
API Reference β every endpoint, request, response, and code sample
The Reference is the exhaustive catalogue of endpoints. Every operation has a request schema, a response schema, error codes, and runnable code samples in cURL, JavaScript, Python, Java, and Go that you can execute against the live demo environment in one click.
What you get on the Developer Hub
The Developer Hub is engineered for high-quality integration work end-to-end. The features below are available across every page in the Reference and the Recipes.
βΆοΈ Try-It playground on every endpoint
Every endpoint in the Reference has a live request panel. Fill in the request body, click Try It!, and you get a real response from the demo environment, complete with status code, headers, and body. No Postman, no curl, no client setup β your browser is the client.
Why this matters: the gap between "reading docs" and "making a successful request" disappears. A new integrator validates the auth flow, the request shape, and the response payload in the same place where they read about the endpoint.
π» Auto-generated code samples in five languages
Each endpoint ships with copy-paste-ready code in cURL, JavaScript (fetch), Python (requests), Java (OkHttp), and Go (net/http). Code samples reflect the exact parameters you typed in the Try-It panel, so the snippet you copy is the exact request you just executed.
Why this matters: you don't translate examples by hand from one language to another. The portal does it for you, with the parameters you already chose.
π Full-text search across docs, recipes, and reference
A single search box (Ctrl+/) covers every page in the Hub β guides, recipes, and reference. Hits are deep-linked to the exact section, parameter, or example that matches.
π Per-developer authentication context
Once you authenticate inside the Hub, your bearer token is injected automatically into every Try-It request and every code sample. You don't manage tokens manually while reading the docs; the Hub does it for you. Every code sample you copy already references your token via environment variable so it runs as-is in your terminal.
π Versioned API definitions
The Reference is versioned. When ANKASecureΒ© ships a new API revision, the previous version's docs remain accessible so existing integrations can finish their migration window without losing their reference material.
π Changelog and discussions
A first-class Changelog publishes every breaking change, deprecation, and additive update with the affected endpoints. Discussions is a public Q&A surface where the community and ANKATech engineers resolve integration questions in the open, so the answers are searchable and outlive the conversation.
Reference, by capability
The Reference is organised into the following sections. Open the Reference and use the left sidebar to dive into any section; each section contains the endpoints, their request and response schemas, error codes, and runnable code samples.
π‘οΈ Authentication
How to obtain and refresh a JWT, what scopes and tenant claims look like, and how the Bearer token flows through every other call.
π Key Creation, Lifecycle, and Lifecycle Transitions
The full key lifecycle: creation (classical, post-quantum, composite hybrid), labelling and tagging, status transitions (active, deprecated, revoked), rotation, deletion, and audit trail.
π Key Query and Key Metadata
How to discover keys you have access to, filter by algorithm, status, owner, or tenant, and read the metadata that drives policy decisions (security level, compliance template, sunset dates).
π Algorithm Catalog
Live, queryable catalogue of every algorithm the platform supports β classical, PQC, and composite β with security levels, performance characteristics, sunset dates, and policy template membership. The catalogue is what crypto-agility renders to: query the catalogue, choose the algorithm at policy level, never wire it into application code.
π Secure (compact JWE / JWS)
Encrypt, decrypt, sign, verify, re-encrypt, and re-sign for payloads up to 5 MB using compact JOSE serialisations. The default surface for "encrypt this JSON, sign this token, decrypt this blob" calls.
π‘ Secure Streaming
The same operations as Secure, but for multi-gigabyte files, using detached JWS and JWET (JSON Web Encryption with Token) streaming. Bound by network and disk, not by memory; tested with multi-TB inputs.
π Migration and Interoperability
Bulk import of existing RSA, ECC, and PQC keys; PKCS#12 onboarding; PKCS#7 β JOSE conversion; ad-hoc utilities for verifying signatures from external systems and producing artifacts external systems can consume.
π Policy Cache Monitoring
Observability surface for the policy engine β which template a tenant resolves to, what's cached at L1/L2, when invalidations propagated. Useful for operations teams running at scale.
π License Metrics
Read your tenant's usage counters, see which operations contributed to the licensed quota, and pull aggregated stats for billing reconciliation.
Recipes β pick a finished workflow and adapt
Recipes solve real integration problems end-to-end. They start from a customer scenario, walk through every API call needed, and end with verified output. Common recipes include:
- First encryption + decryption with a freshly generated key β the canonical "hello world" for ANKASecureΒ©.
- Sign-then-encrypt nested operations β multi-actor signing followed by recipient-bound encryption in one call.
- RSA β ML-KEM migration β re-encrypt existing data from a classical key to a post-quantum key without ever exposing plaintext.
- RSA β ML-DSA re-signing β upgrade legacy signatures to a quantum-resistant scheme while preserving the audit chain.
- Composite hybrid key generation and rotation β set up an AND-decrypt composite (RSA + ML-KEM) and rotate it atomically.
- Streaming re-encryption for multi-GB files β handle the migration of large datasets without blowing client memory.
- PKCS#12 import and decrypt-only key onboarding β bring legacy keystores into ANKASecureΒ© without exporting private keys.
OpenAPI specification
The current OpenAPI 3.0 specification lives inside the Developer Hub. The Hub serves the spec always in sync with the live API, so you can plug it into any OpenAPI client generator (openapi-generator, oapi-codegen, swagger-codegen, etc.) without worrying about drift.
π₯ Get the OpenAPI spec from the Developer Hub
Tip: when you use the Hub's code-sample generator with your own parameters, the generated snippet is exactly what an OpenAPI client would have produced β but tuned to the values you typed.
Demo access
The Developer Hub points at a permanent demo environment that mirrors production behaviour. The demo accepts the same authentication flow, exposes the same endpoints, and enforces the same multi-tenant isolation, so the integration code you write against the demo is the same code you ship.
To request demo credentials (tenant ID, application client ID and secret, optional demo user account), email [email protected] and tell us a little about your intended use case so we can scope the demo tenant appropriately.
Operational limits to keep in mind
| Resource | Demo value | Notes |
|---|---|---|
| Compact endpoint payload size | 5 MB | Use the streaming endpoints for anything larger |
| Streaming endpoint payload size | Multi-GB | Bound by I/O and disk, not by memory |
| Default JWT (access token) lifetime | 1 hour | Refresh proactively or on 401 |
| Refresh-token lifetime | 72 hours | After expiry, re-authenticate from clientId / secret |
Production tenants can request adjusted limits as part of onboarding.
Beyond REST β SDKs and CLIs
If you prefer a typed, idiomatic client over raw HTTP, the same API surface is wrapped by a Java SDK and a set of cross-platform CLIs. They authenticate against the same endpoints, return the same payloads, and interoperate with the demo environment exactly the same way.
- Java SDK overview β Maven coordinates, factory pattern, end-to-end snippets, integration flows.
- CLI commands β scripts and CI/CD jobs that call ANKASecureΒ© without writing code.
- Composite Hybrid Keys quickstart β apply the Recipes flow for AND-decrypt hybrid keys.
Β© 2026 AnkaTech Solutions Inc. All rights reserved.