API Developer Area

Introduction

Welcome to the Jungheinrich Fleet API v1 Documentation. Use the information below to make requests against the Jungheinrich Fleet API.

Base URL

The base url for all requests is:

https://prod.api.jdsaws.com/fleet/v1

Every request has this URL as its base. To access a resource the resource specific path can be appended. For example:

https://prod.api.jdsaws.com/fleet/v1/locations/{location_id}/costs/v1

Where {location_id} is one of your location ids (i.e. the unique ID of one of your sites).

You can retrieve your available locations here:

https://prod.api.jdsaws.com/fleet/v1/locations/v1

Authorization

You’ve been given an api key which you must present in every request. This api key has the following form and must be sent as the x-api-key header.

hnsd7sebsdj28tbsd8febsefb38jio23nnfspefn

Example curl:

curl --request GET \
  --url https://prod.api.jdsaws.com/fleet/v1/locations/test_api_00000000/equipment/v1 \
  --header 'x-api-key: hnsd7sebsdj28tbsd8febsefb38jio23nnfspefn'

Request Overview

Here is a typical API request, the Gateway identifies the customer via the included API Key to authorize locations in which the client has access too.

sequenceDiagram

Client->>API Gateway: request with API Key
API Gateway->>Authorization: API Key
Authorization->>API Gateway: authorized locations
API Gateway->>Endpoint: authorized request
Endpoint->>Client: data

Standards

  • ISO8601 format is used for all timestamps and datetime parameters.
  • OpenAPI v3 is used to document the API capabilities.