🤓Make your first API call

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API keys

Your API requests are authenticated using API tokens. Any request that doesn't include an API token will return an error.

Our team can generate an API key from your account dashboard at any time.

Generate an auth token

The best way to interact with our API is to use one of our official libraries:

Postman

curl --location --request POST 'https://api.akibadigital.com/oauth/v2/token' --data-raw '{

"client_id": "YOUR CLIENT_ID",

"client_secret": "YOUR CLIENT_SECRET",

"client_credentials": "client_credentials" }'

Node

{ "client_id": "YOUR CLIENT_ID", "client_secret": "YOUR CLIENT_SECRET", "grant_type": "client_credentials" }Library is optional: You don't have to use our library to work with our APIs, a direct call using the keys and provided API URL works as well

Make your first request

To make your first request, send an authenticated request to the pets endpoint. This will create a customer, which is nice.

Create New Customer.

POST https://api.akibadigital.com/v1/customer

Creates a new customer.

Request Body

Name	Type	Description
name*	string	The name of the customer
identifier	string	The id of the customer (registration or national Id)
type*	string	1 for individual and 2 for business
verified	boolean	Default false and updated to true when customer is verified

200 Customer successfully created

{
    "name"="Thobie",
    "type": "Individual",
    "identifier": "ABXER2",
    "verified": "false",
}

401 Permission denied

Good to know: You can use the API Method block to fully document an API method. You can also sync your API blocks with an OpenAPI file or URL to auto-populate them.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://api.akibadigital.com/v1/customer 
    -u YOUR_API_KEY:  
    -d name='Thobey'  
    -d type='1'  
    -d identifier='ABXXXX' 
    -d verified='false'

Node

// require the myapi module and set it up with your API key
const myapi = require('myapi')(YOUR_API_KEY);

const newCustomer = away myapi.customer.create({
    name: 'Thobie',
    type: '1',
    identifier: 'ABXXXX',
    verified: 'false',
})

Python

// Set your API key before making the request
myapi.api_key = YOUR_API_KEY

myapi.Customer.create(
    name='Thobie',
    type='1',
    identifier='ABXXXX',
    verified='false',
)