Making a Request

URL Structure

All API requests start with https://api.rightangleeng.com unless otherwise informed by Right Angle Engineering. Generally we will provide a separate URL for testing.

The next segment of the URL path depends on the type of request you want to make. For example, getting job data or updating a job uses the /jobs/<job_id> endpoint, so the full URL would be https://api.rightangleeng.com/jobs/<job_id>

See the API Endpoints section for complete details on available requests.

Authenticating a Request

The API requires an API Key for authentication. To authenticate your request, please pass the API Key via the Authorization header in the request. It must be formatted as follows:

Authorization: Api-Key <API_KEY>

Where <API_KEY> refers to the API Key that was provided to you.

Request Content Types

Unless otherwise noted, API endpoints that accept body parameters expect them to be encoded using one of the following content types:
  • application/json

  • multipart/form-data (for endpoints containing Files/Images/etc.)

Note that the Content-Type header must be set accordingly, and the absence of a Content-Type header may result in unexpected behavior.

Responses

All responses will be returned in JSON format. Files included in a response will be provided through a URL.