This documentation serves as a description for the interface of the webservice provided by the InFLEET Work server.

NOTE: The webservice for InFLEET Work is experimental and will probably be extended and changed in the future. If you have ideas or suggestions how it could be improved, please feel free to contact us: Contact formular

Documentation history

Last update of the documentation: 2020-07-21 (Detailed history)

Prerequisites

Domain

To contact the InFleet Work server use the following domain:

https://work.bornemann.net

Ports

The server listens on two ports:

  • 80 (Standard HTTP) Not recommended. Please use the encrypted connection via HTTPS.
  • 443 (HTTPS) Secure HTTP.

Path

All requests made to the webservice are found under /api/v2/, so that the requests should look like this:

GET https://work.bornemann.net/api/v2/<resource>/

HTTP Methods

Most resources support multiple methods:

  • GET Retrieve a resource (or a list of them).
  • PUT Update a resource.
  • POST Create a new resource.
  • DELETE Delete a resource.

Authentication

InFLEET Work 1.1 supports two methods of authentication:

  1. Session based Session based authentication is the preferred way to authenticate a user working in a browser. Our dispatcher interface uses this method, of course.
  2. Token based Token based authentication is the preferred way if you use some sort of software that is not a browser (for example some plugin for your workforce management software). Please visit the following page for examples and explanations: Token based auth

Browsable API

The webservice and its resources are completely browsable. Please login and explore the available resources:

GET /api/v2/
HTTP 200 OK Vary: Accept Content-Type: text/html; charset=utf-8 Allow: GET, HEAD, OPTIONS
{ "resources": { "reporting": { "uri": "https://work.bornemann.net/api/v2/reporting/", "description": "Access the reports." }, "workforce": { "uri": "https://work.bornemann.net/api/v2/workforce/", "description": "Android App Credentials, Jobs and their statuses." }, "auth": { "uri": "https://work.bornemann.net/api/v2/auth/", "description": "Get information about your company and your dispatcher account. Login, logout and change the password of your dispatcher account." }, "labor": { "uri": "https://work.bornemann.net/api/v2/labor/", "description": "Keep track of the drivers working hours & personal time tracking." }, "sso": { "uri": "https://work.bornemann.net/sso/", "description": "Help documentation for the SSO callback APIs." }, "contact": { "uri": "https://work.bornemann.net/api/v2/contact/", "description": "The dispatcher can store frequently used addresses of customers." } } }