API integration

There are currently four major data entry and management options available:

  • Manual entry through forms (for everyday users)

  • Manual file upload (for power users)

  • Batch file processing (for older systems development)

  • API integration (for newer systems development)

Our user guide provides more detail and a walkthrough of the manual entry and file upload options, including our file upload template and data dictionary. In this developer guide we explain how to integrate with the BankTech platform via API.

We provide a set of synchronous RESTful APIs in JSON format. All modern programming languages (e.g. Java, JavaScript, Ruby, C3, PHP, Python, Groovy) and application platforms provide excellent support for serialising and deserialising JSON data, so you can use data sent by us and send data to us.

If JSON is new to you, you can find more information about it on the RESTFUL API website and explore various guides on its implementation. Rest assured, your developers will love it.

JSON requests are made by the client to the server to either retrieve data from the server or post new data to the server by calling on a method with a header. Methods represent all the API endpoints provided and allow users to interact with the data held by the server. Headers qualify which server the request is being sent to and what method is being used, with a body object that follows.

An example of a JSON request header is provided below:

POST http://www.example.com/customers HTTP/1.1
Host: example.com
Authorization: Bearer AbCdEf123456
Content-Type: application/json

An example of a JSON request body object and array is presented below:

// JSON object
// Create new employee
POST http://www.example.com/employees
{
"employee":
{
"id": 1,
"name": "John Smith",
"age": 35,
"hiredatetime": "2001-10-28T16:40:51.616Z",
"permanent": true,
"location": "South Africa"
}
}
// JSON array
// Create multiple employees at once
POST http://www.example.com/employees
{
"employees":
[
{
"id": 1,
"name": "John Smith",,
"age": 35,
"hiredatetime": "2001-10-28T16:40:51.616Z",
"permanent": true,
"location": "South Africa"
},
{
"id": 2,
"name": "Kim Anderson",
"age": 28,
"hiredatetime": "2001-10-28T16:40:51.616Z",
"permanent": true,
"location": "South Africa"
},
{
"id": 3,
"name": "Sarah Jones",
"age": 31,
"hiredatetime": "2001-10-28T16:40:51.616Z",
"permanent": true,
"location": "South Africa"
}
]
}

To access our API and try out our services you will need API keys. You can request API keys by signing up for an account through our public website or by contacting our support team if you already have an account.