Welcome to the Akowe Developer Documentation where you will learn how to integrate digital certificate issuance into your systems.

API Basics

Akowe API gives you access to pretty much all the features you can use on our dashboard and lets you extend them for use in your application. It strives to be RESTful and is organized around the main resources you would be interacting with - with a few notable exceptions.

Before you do anything

You should create a free Akowe account that you can test the API against. We will provide you with keys that you can use to make API calls.

Sample Requests

We provide sample API calls next to each method using cURL. All you need to do is insert your specific parameters, and you can test the calls from the command line. See this tutorial on using cURL with APIs.

You can also use Postman if you are not familiar with cURL. Postman is an easy to use API development and testing platform. You can explore it to understand how our APIs work.

Requests and Response

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:

Response Format
  "ResponseCode": [string],  // "00" if the details provided could be processed and no error occured while processing
  "ResponseMessage": [string], // Explains why status is false... Entirely informational. Please only log this but do not use for your checks
  "Data": [object]    // contains actionable result of processing if present

We have provided a handy ResponseCode key to let you know upfront if the request was successful or not. "00" represents Success, while other codes would have their corresponding failure message in ResponseMessage.

The ResponseMessage key is a string which will contain a summary of the response and its status. For instance, when trying to retrieve a list of templates, ResponseMessage might read “Successful”. In the event of an error, the message key will contain a description of the error. ResponseCode and ResponseMessage are the only keys that are universal across requests.

The Data key is where you want to look at for the result of your request. It can either be an object or an array depending on the request made. For instance, a request to retrieve templates will return an array of templates earlier created by you.

Last updated