PARiM Clocking API

Name: PARiM Clocking API
Brand: PARiM Clocking API
Availability: InStock

✓ Official Vendor SpecHR recruitingEmployee Managementcustom2 EndpointsREST

For Agents

Record employee clock events and retrieve user lists for workforce scheduling and attendance tracking in PARiM.

Install Jentic One Beta

Connect the PARiM Clocking API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the PARiM Clocking API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fparim.co%2Fparim-clocking" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fparim.co%2Fparim-clocking" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with PARiM Clocking API.

Submit clock events including clock in, clock out, break start/end, check-in, and checkpoint check-in

Record geolocation (latitude, longitude, accuracy) alongside clock events for location verification

Associate clock events with published shifts by user and timestamp

GET STARTED

Start building with PARiM Clocking API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use PARiM Clocking API for, with concrete tasks.

★ Mobile Time Clock Integration

Build a mobile app or kiosk that lets staff clock in and out of shifts without direct PARiM access. POST /clock_events accepts timestamp, location, and event type; PARiM validates against published shifts and records attendance. The signature-based auth ensures only authorized devices can submit clock events on behalf of users.

POST /clock_events with type, user_id, exact_timestamp, latitude, and longitude. Ensure the domain subdomain matches the PARiM instance and the signature headers are correctly computed.

Workforce Synchronization

Sync staff rosters between PARiM and an external HR or payroll system by periodically fetching the user collection. GET /users returns all active, approved, and incomplete users with their external IDs and PARiM UUIDs, allowing bidirectional lookups. Use external_id to map PARiM users to records in your system.

GET /users and iterate the returned array, using external_id and parim_id to reconcile with your HR database.

Key Endpoints

2 endpoints — parim clocking api enables workforce scheduling and time-tracking integration by allowing external applications to submit clock events (clock in, clock out, breaks, check-ins) and retrieve user information for staff members.

METHOD

PATH

DESCRIPTION

POST

/clock_events

Submit a new clock event (clock in, out, break, or check-in)

GET

/users

Retrieve the collection of users (staff, candidates, subcontractors)

POST

/clock_events

Submit a new clock event (clock in, out, break, or check-in)

GET

/users

Retrieve the collection of users (staff, candidates, subcontractors)

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the PARiM Clocking API by hand means resolving your per-tenant domain host and computing the x-auth-parim-signature over a key, timestamp, and nonce for every request. Through Jentic you install once, import PARiM from the API Directory, store the key and secret once, and your agent calls it.

Permission scoping

PARiM carries the employee and shift references in the request body, so scoping is by operation: limit the agent to the operations it needs, such as recording clock events and listing users. You choose the operations it may call, so it stays limited to attendance recording and user lookup.

Credential isolation

Your PARiM key and signing secret are stored once, encrypted, by your own Jentic One instance and used to compute the signature header at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'clock in an employee' or 'get the PARiM user list', and Jentic returns the matching PARiM operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using PARiM Clocking API through Jentic.

What authentication does the PARiM Clocking API use?

The API uses a custom signature-based authentication with five required headers: x-auth-parim-key (public API key), x-auth-parim-timestamp (current unix timestamp), x-auth-parim-nonce (unique value), x-auth-parim-signature (HMAC signature), and X-PARiM-Domain (subdomain). Jentic can store the key and secret and construct the signature headers at execution time.

Can I submit clock events for any user?

No. Clock events require a published shift to exist for the user at the specified time. If no published shift is found, the API returns HTTP 428. This ensures clock events are tied to actual work schedules.

Does the API support geolocation for clock events?

Yes. Each clock event can include latitude, longitude, and accuracy (in meters). These fields are optional but recommended for location verification of mobile clocking.

Can I limit what my agent is allowed to do with the PARiM Clocking API?

Yes. Because you run Jentic One yourself, your own rules decide which PARiM operations the agent may call, and it only ever reaches the two operations this API exposes: recording clock events (POST /clock_events) and listing users (GET /users). You can allow just the user lookup for read-only synchronization, or grant clock-event submission as well when the agent needs to record attendance. The stored key and signing secret are held by your own instance and applied at execution time, so the agent never sees them and stays limited to the operations you permit.