API Overview

API Requests

To make REST API call, you need to combine our HTTP GET, POST or PUT methods, the URL to API service, the URI to a resource to query, submit data to, update, and one or more HTTP request headers.

Sandbox/Live URLs

The API Key is a prerequisite to login into the sandbox, which will be generated and shared to end client via secured mechanism before you start using our service.

• Sandbox: The current version of the API lives at:https://sandboxapi.fieldengineer.io/v1

HTTP request headers

Access control of Field Engineer platform APIs comprises of authentication, authorization and auditing. Authentication will be done using API Keys which will determine who the end client is, authorization will determine what resources end client can access, and auditing logs records end client’s activity.

API Key will be generated and shared to end client via secured mechanism.

Accept

The response format, which is required for operations with a response body. The syntax is:

Accept: application/<format>

Where format is json

Authorization

Include the API Key in the Authorization header with the Bearer authentication.

Authorization: Bearer <API Key>

apiKey is the API key assigned to your company

Content-Type

The request format, which is required for operations with a request body. The syntax is:

Content-Type: application/<format>

Where format is json.

Username

username is your company Username