Okappy is a B2B workforce management platform where you can connect to your customers, employees and subcontractors. Send and receive jobs and assign them to your employees AND subcontractors. You can also raise invoices to your customers and receive invoices from your subcontractors.

To get your list of invoices using the Okappy API, follow the instructions below.

First you will need to get an up to date authentication token.  For further information see authenticating with Okappy.

Get your list of jobs using the following endpoint.

GET /invoices

The token should be a string taken from the “access_token” field of a response to an authorise request.

No parameters.

Okappy is a B2B workforce management platform consisting of companies, employees and devices.  Companies can connect to customers, subcontractors and employees. Add jobs and then assign those jobs to an employee or subcontractor. You can also raise invoices to your customers or receive invoices from your subcontractors.

To raise an invoice using the Okappy API, follow the instructions below.

First you will need to get an up to date authentication token.  For further information see authenticating with Okappy.

Raise an invoice using the following endpoint.

POST /invoices

The token should be a string taken from the “access_token” field of a response to an authorise request.

No parameters

The following table lists the fields that may be present in the body data:

If an array of invoice items is included in the body data, these are the fields may be included in each item.

Okappy is a B2B workforce management platform consisting of companies, employees and devices.  Companies can connect to customers, subcontractors and employees. Add jobs and then assign those jobs to an employee or subcontractor.

To create a job using the Okappy API, follow the instructions below

First you will need to get an up to date authentication token.  For further information see authenticating with Okappy.

Add a job using the following endpoint.

POST /jobs

The token should be a string taken from the “access_token” field of a response to an authorise request.

No parameters

The following table lists the fields that may be present in the body data:

Okappy is a B2B workforce management platform where you can connect to your customers, employees and subcontractors.

To get the details for one of your jobs using the Okappy API, follow the instructions below

First you will need to get an up to date authentication token. For further information see authenticating with Okappy.

Get details of your job using the following endpoint.

GET /jobs/{jobId}

The token should be a string taken from the “access_token” field of a response to an authorise request.

No parameters

Okappy is a B2B workforce management platform where you can connect to your customers, employees and subcontractors. Send and receive jobs and assign them to your employees AND subcontractors.

To get your list of jobs using the Okappy API, follow the instructions below

First you will need to get an up to date authentication token.  For further information see authenticating with Okappy.

Get your list of jobs using the following endpoint.

GET /jobs

The token should be a string taken from the “access_token” field of a response to an authorise request.

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

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

Check the Use sandbox checkbox to turn sandbox on.

Okappy is a B2B workforce management platform where you can connect to your customers, employees and subcontractors. Send and receive jobs and see the status of those jobs as they’re updated by your employee or subcontractor.

You can also raise invoice for your customers and receive invoices from your subcontractors.

The base url for connecting to the Okappy API is

https://api.okappy.com/rest/v2

Select from the options on the left to find out more about using the Okappy API v2 (beta)

Okappy is a B2B market network consisting of companies, employees and devices.  Companies can connect to each other in a customer, subcontractor relationship.

Employees and devices are part of a company.

To create a connection using the Okappy API, follow the instructions below

First you will need to get an up to date authentication token.  For further information see authenticating with Okappy.

Add a connection to an account using the following endpoint.

POST /connections

Note: You can send an invite by email to your connection.

The token should be a string taken from the “access_token” field of a response to an authorise request.

No parameters

The body data of the request should contain a JSON object with the following basic structure:

{
"firstName" : "Joe",
"lastName" : "Bloggs",
"companyName" : "New company",
"email" : "joe.bloggs@newcompany.com",
"contactPhone" : "020709980000"
}

The following table lists the fields that may be present in the body data:

The first step in using the Okappy API is to authenticate with Okappy using the following endpoint

POST /authentication

The token should be a BASIC authorisation token comprised of the word ‘BASIC’ in capitals, followed by exactly one space, then a Base64 encoded string containing the username & password separated by a colon, e.g. “username:password”.

No parameters

A 200 response will contain a text/plain string, which is a JSON object with the following structure:

{
"access_token" : <access_token>,
"token_type" : "Bearer",
"expires_in" : <int_seconds>:
}

The access_token field contains a JWT which should be used as the bearer token in subsequent requests.

The exp field of the JWT payload contains an epoch expiry date, which should be used for accurate scheduling of JWT refreshment.

To refresh a breaker token use

POST /authentication/refresh

The token should be a string taken from the “access_token” field of a response to an authorise request.

No parameters

A 200 response will contain a text/plain string, which is a JSON object with the following structure:

{
"access_token": <access_token>,
"token_type": "Bearer",
"expires_in": <int_seconds>
}

The access_token field contains a refreshed JWT which should be used as the bearer token in subsequent requests.