Getting Started
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 environment for developers to test, stage and deploy into production.
| Sandbox | Staging | Production: Akaun.com | |
|---|---|---|---|
Custom Hostnames |
*.akaun.xyz |
*.akaun.app |
*.akaun.net |
Region |
Singapore |
Singapore |
Singapore |
Status |
Live |
Live |
Live |
Description |
This is the developer sandbox to experiments , test and develop. |
This is for UAT, Demo, Final testing before deployment to the production environment. |
This is the global live environment. |
Shell Website |
|||
API |
api.akaun.dev |
api.akaun.cloud |
api.akaun.com |
Registration of developer account
As a new developer, the developer should register an account in Production environment via the website: https://akaun.com. These are the brief registration steps:
-
Register an account using either email or phone number
-
Activate account using 6 digits number
Registration of user account in production environment
A new user should register an account at: https://akaun.com:
-
Register an account using either email or phone number
-
Activate account using 6 digits number
-
Login and install desired applets
Vendor and Developer Registration
Registration of user account in development environment
Similar to product environment, a new user register a development account at: https://akaun.dev
-
Register an account using the same email or phone at https://akaun.com
-
Activate account using 6 digits number
-
Login and install desired applets
Obtaining access id and access key
These access key is required as credential to call etl endpoint. Please go to https://akaun.prod (depending on the environment) and follow these step:
System Integration Applet
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 stoplight documentation: https://bigledger.stoplight.io/docs/blg-akaun-api-docs-public
Environment |
Website URL |
Api URL |
Sandbox (development) |
||
Staging environment |
||
Production environment |
Notice: AuthToken is refreshed every month, developers should get new authToken once every month(for testing api using authtoken**not applicable for etl endpoint).
Below is the method to get authToken using sandbox (development) environment as an example
-
Login into https://akaun.dev
-
Right click on an empty space and choose “Inspect”
-
Find “Local Storage” under “Storage” tag
Using the “System Integration Applet”
Example of frequently used APIs
a. Product API
b. Customer API
c. Sales Order API
Understanding Triggers and Web hooks
When you are integrating with the Akaun Platform, instead of polling the APIs with repetitive schedulers, it is possible for the system integrators to be using Web Hooks for more efficient integrations.
Webhooks
a. Briefing on webhook
Webhooks are used in BigLedger to allow external integrations to be called whenever a particular event occurs. Usually, the event is an API call received by BigLedger.
For any kind of event such as creating vouchers or creating Items:
-
From BigLedger side, a topic of webhook is created
-
From external side, they will need to subscribe to those topics. And later when they do any operations like "create Item", the webhook will be triggered and they will get a response.
Virtual ETL Applet
Virtual Etl applet is an applet which for setting purpose including organization of the permission for etl APIs. Platform Sysadmin will be in charge of installing the the applet and granting necessary permission to access etl APIs.
Once the permission granted, the user may try to access the endpoint to ensure the permissions are successfully granted. The user also may visit this applet to see the list of permission being granted.