What is an API?

You've probably heard the term, but what does it actually mean?

API stands for Application Programming Interface, although that makes it sound more complicated than it really is!

An API is simply a way for one system or application to talk to another via a series of messages or requests. Whilst the visual interface you interact with via your mouse, keyboard or mobile device is for humans, an API is an interface for software to interact with other software.

There are many different types of API, but the principle is the same: a means for one system to interact with another, without direct human input.

πŸ“– REST, HTTP & JSON

More acronyms, so let's demystify these terms!

The Claimable API is a REST API with the primary purpose of two-way data exchange.

A REST API like the Claimable API responds to commands issued to it, via HTTP requests, sending back data in the JSON format. The API will also accept JSON data sent along with the request to create and update records.

This two-way exchange of data, via a series of individual requests is the basis for how to interact with a REST API. This Developer Hub explains what resources you can access (e.g. claims, contacts etc.) and the operations you can perform on each (e.g. fetch, create etc.).

Each resource is available at a "location" described by a URL. This is called an endpoint. The Claimable API offers many endpoints and you can see an overview what's available in our API Reference.