API

Overview

We enable developers to integrate directly with our platform via our REST API.

What is an API?

An API (application programming interface) is a set of definitions and protocols that allows for two systems to “talk” to each other.

Using an online shop as a practical example, when you type your credit card details in and click “pay”, the online shop uses an API to talk to the “payment gateway” to process the transaction and ultimately deduct the money from your bank account.

What is a REST API?

A REST API (Representational State Transfer Application Programming Interface) is a set of rules and conventions for building and interacting with web services.

• It uses the HTTP protocol.
• It centers around resources - objects or things you can interact with (e.g. orders, payments).
• It allows for a typical request/response interaction between a client and server.
• It uses the standard HTTP methods for reading and writing data.
  • GET: Retrieve information about a resource.
  • POST: Create a new resource.
  • PUT: Update a resource.
  • DELETE: Remove a resource.
  • PATCH: Perform a partial update to a resource.
• It is completely stateless.
• It allows for information to be cached (temporarily stored).
• It allows for encrypted communication over HTTPS using TLS.
• It caters for authentication using an Authorization header.