Testing AnkaSecure API via Swagger UI

This page explains how to authenticate and test the Key Management and Secure (non-streaming) endpoints directly from the interactive Swagger interface located at /swagger-ui/index.html.

1. Open the Swagger UI

Navigate to: /swagger-encryption/ in your browser. You should see an interface listing endpoints like Key Management, Secure, and Secure Streaming.

2. Authenticate to Obtain a JWT Token

Most endpoints require a valid JWT token. We’ll demonstrate using /api/authenticate/app for application-based authentication:

Scroll down to the Authentication section in Swagger UI.
Click on POST /api/authenticate/app.
Click Try it out, then expand the “Request Body”.

Enter valid clientId and clientSecret in JSON format. For example:

{
  "clientId": "myAppId",
  "clientSecret": "myAppSecret"
}

Click Execute.
If successful, you should see a 200 response with JSON including "token" and "refreshToken". Copy the "token" value.

Note: You can also use POST /api/authenticate/login if you want user-based authentication instead of application-based. The concept is identical: provide username/password, copy the returned token.

3. Authorize with Your Token

At the top-right corner of the Swagger UI, there’s usually an Authorize button (green lock icon or similar). Click it.

A pop-up will appear asking for a Bearer token or similar.
Paste your copied token (e.g. eyJh...) in the Value field, prepending Bearer if required. For example:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Click Authorize, then Close.

Now Swagger UI includes your JWT token in the Authorization header for all subsequent requests, letting you access secured endpoints.

4. Test Key Management & Secure Endpoints

With your token set, you can test various endpoints:

Key Management:
- POST /api/key-management/asymmetric (generate an asymmetric key)
- POST /api/key-management/symmetric (generate a symmetric key)
- GET /api/key-management/keys (list keys)
- GET /api/key-management/public-keys/{alias} (export a public key), etc.
Try generating a key, exporting the public key, etc.
Secure (non-streaming) endpoints:
- POST /api/crypto/sign: sign data (Base64 input)
- POST /api/crypto/verify: verify a signature (Base64 input)
- POST /api/crypto/symmetric/encrypt: encrypt data with a symmetric key
- POST /api/crypto/reencrypt: re-encrypt from one key to another, etc.
You can click Try it out, fill in the JSON body with Base64 data and your key alias, then Execute.

Check the Response body to see results (encrypted or signed data in Base64, verification status, etc.).

Streaming Endpoints: Most of the Secure Streaming endpoints use multipart/form-data with file uploads. Swagger UI supports basic file inputs, but some advanced flows (like re-encrypt streaming or sign-file-stream) can be tricky to test via the browser. Often, it’s easier to use the CLI or custom scripts for large-file streaming.

5. Done!

You’ve now tested the AnkaSecure API directly via Swagger UI. Remember to re-Authorize with a fresh token if your JWT expires. You can also call /api/authenticate/refresh to get a new token if you have a refresh token.

For more complex streaming or file-based operations, see our CLI Usage and Use Cases pages.