API — Technical Overview and Setup
Get started with the Core Inspection REST API: Basic Auth with an admin login, a /HeartBeat connection test in Postman, and the full Swagger method list.
Last updated
The intended audience of this document is technical users that are wanting to implement the Core Inspection API to automate operations or integrate to external systems. An understanding of JSON, API structures and programming is assumed.
Security
The API uses basic authentication for all operations. A valid user is an admin in Core Inspection where the username is your email address.
Checking Your Connection
A simple test is to access via Postman (which can either be done directly online or downloaded) through a simple GET command such as /HeartBeat as per the image below.
This should result in a 200 response code.
Method Definition
A full list of available interfaces is online through a Swagger interface at https://api4.coreinspection.com/swagger/. This will develop over time and is always best to check here for any updates.