# API Reference

This documentation is for `Encedo nGINE v.1.0` and is a part of a Common Criteria *"Guidance documentation"* (AGD) and covers all API operations. 

For simplicity, in all examples, the default domain for Encedo PPA `my.ence.do` is used. Replace `my.ence.do` with a real application domain name.

The certified configuration version is listed [here](https://docs.encedo.com/hem-api/~/revisions/1sgifhZ64anc2fyTUTgt/reference/api-reference/system/version-and-status).
\\

\
The certified version of this manual is [here](https://docs.encedo.com/hem-api/~/revisions/1sgifhZ64anc2fyTUTgt/) (Version hash: [1sgifhZ64anc2fyTUTgt](https://github.com/encedo/hem-api-docs/commit/33287dd3de1389dd7b548501f31776fee936331d)).

Request data arguments with `*` (asterisks) are mandatory; the others are optional.

Version: 1.7b (17.01.2026)

## System

All the methods associated with the device configuration, versions or current status:

{% content-ref url="/pages/HMB0a4QXeYrzij31Uz0u" %}
[System](/hem-api/reference/api-reference/system.md)
{% endcontent-ref %}

## Authorization

Everything related to user authorisation (including Local and Remote users):

{% content-ref url="/pages/NGqdjwT3IhOjqJ8WBf2h" %}
[Authorization](/hem-api/reference/api-reference/authorization.md)
{% endcontent-ref %}

## Key Management

Everything related to key management

{% content-ref url="/pages/RO0JCr33Bntbh0a2zsyB" %}
[Key Management](/hem-api/reference/api-reference/key-management.md)
{% endcontent-ref %}

## Cryptography operations

Everything related to cryptography operations:

{% content-ref url="/pages/i9BKE7ISRMmrFJn1Rr9h" %}
[Cryptography operations](/hem-api/reference/api-reference/cryptography-operations.md)
{% endcontent-ref %}

## Audit log

Everything related to audit log access:

{% content-ref url="/pages/BedVV2z5li0AG4W5svU1" %}
[Audit log](/hem-api/reference/api-reference/audit-log.md)
{% endcontent-ref %}

## Flash drive

A bonus, Encedo PPA is an encrypted, secure Flash Drive :)

{% content-ref url="/pages/2p8bvqmjCcZPHqOTct5k" %}
[Storage](/hem-api/reference/api-reference/storage.md)
{% endcontent-ref %}

##


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.encedo.com/hem-api/reference/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.