# Alemba API Architecture

<figure><img src="https://content.gitbook.com/content/hlW9jKl7dcDggHAPhNU9/blobs/wySewObCg5UPiFhYYZw0/Screen%20Shot%202022-12-01%20at%2010.20.35%20AM.png" alt=""><figcaption></figcaption></figure>

## Included with the Installation

* Alemba.Web, containing:
  * Authorization service – allows you to login and provides a token to use for all subsequent API calls
  * The API Explorer which is an interactive UI for understanding the API, including live search facilities as well as detailed technical information regarding all the available entities and actions
* Alemba.API – the main API
* The Alemba API also provides many new tables of metadata in the ASM database.

## ASM version 10.6.8 API Enhancements

**The Alemba API for HERMES 10.6.8 supports all previous API capabilities and&#x20;*****also*****&#x20;supports:**

1. Custom Fields/Extension Fields
2. Attachments
   * Attachments in Base64 Format to simplify the process and support via Logic Apps (*As of Build 13255*).
   * Attachments can be serialized in and embedded in a response so that separate calls are not necessary (*As of Build 14379*).
3. Data
   * Returning the HTML versions of the Abstract, Solution or Additional Information fields from Knowledge Articles (*As of Build 13283*).
   * *See also*[ *Webhook Payload*](https://docs.alemba.com/asm-hermes-10.6.8/integrate/managing-integration/webhooks#steps-to-add-a-webhook): The **ActionHistoryId** ref can be used to retrieve a history item via the Alemba API. Eg. api/v2/call/404/history?$select=Order,ActionTitle,ActionDescription&$Filter=Order=18
4. SLM
   * The Alemba API can stop the SLA Clock based on configured [Call Statuses](https://docs.alemba.com/asm-hermes-10.6.8/setup-and-configure-asm/configuring-your-system/system-administration-settings/ipk-and-workflow/incident-problem-and-known-error-ipk-management/call-status-titles) (*As of Build 13368*).&#x20;
5. Closure Methods/Rules
   * All Closure Methods inc Immediate, Comments and Rules (*As of Build 13498*).
6. Call, Task, Request History Search
   * **End Point**:  api/v2/\[entity]/history
   * **API Explorer**&#x20;

     * Permissions are based on existing IPK or Workflow Roles
     * Optional Query String: showSystemActions
     * No Private Entries will be returned

     <figure><img src="https://1375663122-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhlW9jKl7dcDggHAPhNU9%2Fuploads%2FYdqIbJtv9VDWEk74jWXq%2Fimage.png?alt=media&#x26;token=ca4cc7d4-d727-43c5-9bec-ee1dfbb113bc" alt=""><figcaption></figcaption></figure>
