Using the Okappy API

Authentication
Using the Sandbox

Creating a connection
Retrieving the details for a connection
Getting your list of connections

Retrieving job templates
Creating a job templates
Creating a job
Retrieving the details of a job
Getting your list of jobs
Updating a job
Assigning a job

Raising an invoice
Retrieving the details of an invoice
Getting your list of invoices

Creating device locations
Getting device locations

Using the API sandbox

When you’re getting started with the API, you can first check your implementation using the Okappy sandbox.

Using the sandbox ensures that any changes you make via the API won’t affect your live account.

To turn the sandbox on or off,

  1. Click your Profile icon and then System settings
  2. Choose Company settings
  3. Click Integration settings

okappy api sandbox

Check the Use sandbox checkbox to turn the sandbox on or off.