System Integrator Guide for Akaun API

This guide is meant for system integrators who are not developing Akaun Applets. Third-party system integrators refer to developers intending to consume the Akaun API.

Developer Account Registration and Configuration

Akaun provides various environments for developers to test, stage, and deploy into production.

Environments Overview

Registration of Developer Account

As a new developer, you should register an account in the Production environment via Akaun.com. Here are the brief registration steps:

• Register an account using either email or phone number.

• Activate your account using a 6-digit number.

Registration of User Account in Production Environment

A new user should register an account at: Akaun.com.

Steps:

• Register an account using either email or phone number.

• Activate your account using a 6-digit number.

• Log in and install desired applets.

Vendor and Developer Registration

Registration of User Account in Development Environment

Similar to the Production environment, a new user should register a development account at: Akaun.dev.

Steps:

• Register an account using the same email or phone as at Akaun.com.

• Activate your account using a 6-digit number.

• Log in and install desired applets.

Obtaining Access ID and Access Key

You will need an access key as a credential to call the ETL endpoint. Please go to Akaun.prod (depending on the environment) and follow these steps:

Open

Open

Understanding Akaun Applet Platform

Akaun Platform System Diagram

Understanding Various Endpoint-Based Permission Schemes

Using the API Reference

API Testing

Software Tools to Test the APIs

API developers may test the API in the Stoplight documentation: Stoplight API Documentation

API Testing Environments

Method to Get AuthToken (using Sandbox environment as an example)

1. Login to Akaun.dev.

2. Right-click on an empty space and choose "Inspect".

3. Find "Local Storage" under the "Storage" tab.

Using the "System Integration Applet"

Here are some frequently used APIs:

• Product API

• Customer API

• Sales Order API

Understanding Triggers and Webhooks

When you are integrating with the Akaun Platform, instead of polling the APIs with repetitive schedulers, it is possible for system integrators to use Webhooks for more efficient integrations.

Webhooks

Webhooks are used in BigLedger to allow external integrations to be triggered whenever a specific event occurs. For example, an event like creating vouchers or creating items.

Steps for using Webhooks:

• From BigLedger's side, a webhook topic is created.

• On the external side, they need to subscribe to those topics. When they perform operations like "create item," the webhook will be triggered, and they will receive a response.

Virtual ETL Applet

The Virtual ETL Applet is used for setting up and organizing permissions for ETL APIs. The Platform SysAdmin is responsible for installing the applet and granting the necessary permissions to access ETL APIs.

Once permissions are granted, users can access the endpoint to ensure permissions have been successfully granted. The user can also visit the applet to see the list of permissions granted.