Skip to content
English
Go to inspectly.com
  • There are no suggestions because the search field is empty.

API

Purpose

As a client of Inspectly you can gain access to our API. This can be used to build up integrations between your existing ERP-system and Inspectly. 

Please notice that Inspectly do not offer development of the specific integration, but we do however gladly help our clients using the API so that we together can create strong integrations between our respective systems.

Usage of our API

You can build many different integrations using our API. Depending of the nature of our company and 
IT-policies some of the following could be good examples:
  • Synchronization of projects and clients
  • Managing scheme configurations and appending these to projects
  • Synchronization of documents and floor plans
  • Extraction of registrations

Price

The API access is free for every client that has no arrears and has an ongoing subscription on our services

Technical documentation

On the following URL you can read the technical documentation for our API.
https://publicapi.inspectly.com/doc/index.html?url=/openapi/v1/openapi.json

Authentication

To authenticate with the API, you need to add 2 headers to your request. Both of these pieces of information, you'll get by reaching out to Inspectlys Customer Success team at support@inspectly.com

  1. X-ApiSecret
  2. X-ApiToken

Paging

We use pagination in the API. Each endpoint has a pagesize of 100 objects and is currently not customizable.
We are using the odata standard which means the object in GET-calls has a value-property for the data object, and a nextLink-property for the next page. The JSON would look as follows:

{ value: [{ listOfObjects }], nextLink: string }

Limits

To ensure the availability of the API to all our customers, we have set up below limits. All limits are per grant token.

The limit is 100 api calls per minute and when reaching the limit you'll get a HTTP error code 429

Filtering & Sorting

When making GET requests to the API, you'll have the option to filter and sort the results as you like. The properties you are able to use for these functions, is a part of the documentation for each endpoint.

For filtering and sorting we use odata, which means you are able to add the $filter and the $orderby parameter to each request in the querystring. See this URL for odata documentation: https://www.odata.org

Error handling

If you send malformed data to the API you will get a validation error object. This error object will be formed based on the standards of FluentValidation.

HTTP codes

  • 200 request successfull
  • 201 request created object successfully
  • 400 validation error
  • 401 unauthorized
  • 429 too many requests. Read "limits" section
  • 500 internal server error. Most often due to an error in Inspectly. Please contact inspectly by clicking here