Wagestream

Start streaming in less than 5 minutes

Wagestream makes it easy to connect your HR & Timekeeping system to our platform.

Follow our Quick Start guide to see what a minimal integration looks like, or view the full API Reference.

Get Started

Authentication

How Wagestream API authentication works

Every endpoint requires an API Key. You will receive an HTTP 403 Unauthorized error if attempting to access any endpoint without a valid API Key.

Obtaining an API Key

If you are already working with Wagestream, your Partner Success Manager (PSM) will give you your API key. If you've lost it, contact support@wagestream.co.uk and they will get it right over.

If you are not working with Wagestream, why not contact our sales team at sales@wagestream.co.uk? They can get you up-and-running with a trial account in less than 2 minutes.

If you are a developer and you just want to play around, you can register for a temporary API key. It will only be valid for 7 days.

How to use your API Key

You can log into the developer portal in the top right, and all of the code examples will be pre-filled with your API Key.

If you want to write your own code, simply include an HTTP header with all requests:

x-api-key: YOURAPIKEYHERE

IP whitelisting and site-to-site VPNs

When your Wagestream account in in trial mode, APIs will be accessible from any IP address.

However, when it comes time to "go live", we recommend instituting one or more further layers of security.

IP Whitelist

Contact your Partner Success Manager with one or more IP address blocks in CIDR notation and we will lock down your API to just that range. Any traffic from other IP addresses will be shadowbanned (meaning, the request will appear to have succeeded, with the usual HTTP response, but will be silently ignored).

Site-to-site VPN

Wagestream's APIs are hosted in Amazon Web Services, in the data center appropriate for your company's data (eu-west-1, eu-west-2, or us-east-1). The strongest possible security involves setting up a site-to-site VPN between your servers and a dedicated EC2 VPC. Doing so is beyond the scope of this article, but if you're interested contact netops@wagestream.co.uk to learn more.

Authentication


How Wagestream API authentication works

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.