When I Work Punch API
A punch is an event where a user clocks in or clocks out. Punches can be managed to restrict where an employee can clock in/out and from what devices.If a user forgets to clock out, they will be allowed to clock in after 9 hours from the end of their scheduled shift. If there is no scheduled shift, the user can clock in again after 18 hours from when they originally clocked in.
When I Work Punch API is one of 22 APIs that When I Work publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 8 JSON Schema definitions.
Tagged areas include Punch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 8 JSON Schemas.
This API exposes 3 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.wheniwork.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
When I Work Punch API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JSON Web Token) (W-Token).
By default, every request must be authenticated.
W-Token— Authentication with When I Work is based on a token model using [JSON Web Tokens](https://jwt.io/). First, you authenticate using a private developer key and t…
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
A punch is an event where a user clocks in or clocks out. Punches can be managed to restrict where an employee can clock in/out and from what devices. If a user forgets to clock o…
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Time (27 properties), User (23 properties), PunchStateShiftBreakBase (11 properties), PunchResponse (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from When I Work 12
Other APIs When I Work publishes across the network.