Skip to content

Communication Format

Authentication

The EveryPoint API resides at the https://api.everypoint.io base URL, with the current supported version available at https://api.everypoint.io/v3/. All requests to the API must be authenticated using basic HTTP authentication, which requires two values (a key and a secret) to be included as part of a request's Authorization header.

After creating an account and entering your payment info, you can retrieve your key and secret via your account's API Keys page, where the keys then serve as your access credentials to the API.

Successful Response

A successful response indicates that the request or operation was successful, and the response body will look similar to the following:

{
  "success": true,
  "data": {...}
}

Here, the "data" section contains the available details of the response (requested resource attributes, etc).

Unsuccessful Response

An unsuccessful response indicates that there was some error with the request (improper formatting, invalid data, etc) or some other issue occurred in the processing of the request. The response body will look similar to the following:

{
  "success": false,
  "code": ...,
  "message": "..."
}

Here, both "code" and "message" refer to what went wrong, where "code" is an integer value that is an error code indicating the type of problem that occurred, and "message" contains a human-readable description of the error.

Error Codes

The following is a list of the error codes supported by the API.

Formatting errors:

  • 1000 - Missing Authorization header
  • 1001 - Incorrect Authorization header
  • 1002 - Inaccessible or incorrect URL
  • 1003 - Invalid parameters
  • 1004 - Unsupported HTTP method
  • 1005 - Invalid timestamp value

Logical API errors:

  • 2000 - Attempting to delete a job that is currently running
  • 2001 - Invalid resource
  • 2003 - Invalid function
  • 2004 - Invalid job
  • 2005 - Upload of resource failed
  • 2006 - Invalid inputs for job
  • 2007 - Unsupported file type
  • 2008 - Invalid custom attribute
  • 2009 - Duplicate custom attribute
  • 2010 - Both GPS latitude and longitude are required
  • 2011 - Invalid query parameters
  • 2012 - Invalid attribute
  • 2013 - Invalid instance
  • 2014 - Duplicate instance name
  • 2015 - Invalid folder
  • 2016 - Duplicate folder name
  • 2017 - Invalid files
  • 2018 - Invalid share
  • 2019 - Invalid operation on shared folder
  • 2020 - Invalid operation on file in shared folder
  • 2021 - Invalid sensor
  • 2022 - Invalid annotation
  • 2023 - Invalid label
  • 2024 - Invalid action
  • 2025 - Invalid trigger

Runtime errors:

  • 3000 - Function processing failed

HTTP Status Codes

In addition to information in the response's JSON body, standard HTTP status codes are used to communicate the status of the request.

  • 200 (OK) - Returned for all successful requests
  • 400 (Bad Request) - Returned when a request has incorrect syntax
  • 401 (Unauthorized) - Returned when a request fails to provide a recognized Authorization header
  • 404 (Not Found) - Returned when attempting to access a URL that does not exist
  • 500 (Internal Server Error) - Returned when the server has encountered an internal error