Overview

Getting Started

Please contact our sales team to get set up with our WurkNow API: hello@wurknow.com

Implementation Process

• Step 1: Discovery call with WurkNow's API team to discuss project requirements, goals, and best practices.
• Step 2: Develop your integration against our testing environment. Please contact support@wurknow.com, to set up your API access and get a client_id and client_secret.
• Step 3: Upon completion of your configuration, you will receive a clientlD and clientSecret key that will be used to authenticate against our API.
• Step 4: Prior to deploying on Production, another call with our API team to review your process, answer any questions, and get you set up against our Production environment.

Getting Help

Please contact support@wurknow.com to request help with the API. We will be happy to answer any questions/ clarifications required to implement the API.

Authentication

The WurkNow API uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client side code, and so forth. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Headers - API environment

Keys	Value
apiKey	XXXXXXXX
AgencyId	XXXXXXXX

Errors

WurkNow uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given
the information provided Codes in the 5xx range indicate an error with Wurknow servers. Some 4xx errors that could be handled programmatically (e.g., a Employee already exists)

Error Code	Meaning
400	Bad Request – Your request has Problems
401	Unauthorized Request: Either API key or Client key is invalid
403	Forbidden – Insufficient permissions to a resource
404	Not Found – The specified resource could not be found
405	Method Not Allowed – Access to resource with an invalid method
500	Internal Server Error – Server encountered an unexpected condition that prevented it from fulfilling the request

Getting Started#

Implementation Process#

Getting Help#

Authentication#