Introduction¶ ↑

The Wonolo API (V2.0) is a RESTful API to perform CRUD operations on Wonolo platform resources.

Currently, JSON is the only encoding format supported.

API Keys¶ ↑

Use of the Wonolo API requires keys. To obtain API keys, please apply here.

Test and Production Environments¶ ↑

You will be issued with two sets of API keys:

test (starting with pk_test and sk_test) - for use with test.wonolo.com/api_v2
production (starting with pk_live and sk_live) - for use with api.wonolo.com/api_v2

Security / HTTPS¶ ↑

All API calls must be made over HTTPS.

With the exception of /authenticate and /info, all API calls must use an authorization token (passed as the token parameter).

Webhooks¶ ↑

Webhooks allow your system to be notified of changes to certain Wonolo resources via an HTTP call initiated from the Wonolo platform.

Currently, webhooks are available for state changes to JobRequest and Job resources.

Webhook Security¶ ↑

Webhooks are authenticated using a X-Wonolo-Webhook-Token HTTP header. This header is set to a SHA256 digest of the webhook's JSON body concatenated with your secret API key.

Configuring Webhooks¶ ↑

To enable webhooks, please first obtain your API keys and then contact us.

Access Control / Priviledge Levels¶ ↑

Wonolo API keys will provide one of two different levels of access to Wonolo resources:

Public Pool access - if you are accessing Wonolo's public pool of Wonoloers
Private Pool access - if your company is managing its own private pool of workers

With Public Pool access, you will only be able to access those Wonoloers you have active Jobs with, and Job Requests and Jobs that you have created. Also, write operations (update/PATCH and create/POST) are forbidden in many cases.

For more details, consult the documentation of the individual endpoints.

Getting Started¶ ↑

Once you receive your API keys, the first step is to authenticate to obtain a token for use with subsequent API calls. Please refer to the /api_v2/authenticate endpoint documentation below.

2015-2017 Wonolo Inc. All rights reserved.