Developer Portal

Build on the SoftTechIQ Platform

REST APIs, webhooks, and integration tools for connecting attendance, devices, and IoT events to your applications — with enterprise-grade authentication, rate limits, and developer support.

Documentation

API & Integration Guides

Everything you need to integrate with SoftTechIQ — from authentication and quick start to webhooks, rate limits, and error handling.

Base URL: https://api.softtechiq.com/v1

API Documentation

Overview of the SoftTechIQ REST API for attendance, devices, and platform integrations.

Authentication

Authenticate API requests using organization-scoped Bearer tokens.

SDK

Official client libraries for faster integration.

Webhooks

Receive real-time event notifications at your endpoint.

Postman Collection

Import ready-made API requests into Postman.

Error Codes

Standard HTTP status codes and API error responses.

Support

Get help from the SoftTechIQ developer support team.

Future Developer Portal

What is coming next for SoftTechIQ developers.

API Documentation

Overview of the SoftTechIQ REST API for attendance, devices, and platform integrations.

The SoftTechIQ API is a RESTful JSON API that provides programmatic access to attendance records, device events, organization data, and webhooks. All requests are made over HTTPS and responses are returned in JSON format.

The API is organized around resources — Attendance, Devices, Events, Organizations, and Webhooks. Use standard HTTP methods (GET, POST, PUT, DELETE) and authenticate every request with a Bearer API key.

RESTful JSON API over HTTPS
Versioned base URL: /v1
OpenAPI specification (coming soon)
Sandbox environment for testing
Pagination on all list endpoints

Device Cloud API Product → Help Center →

Authentication

Authenticate API requests using organization-scoped Bearer tokens.

SoftTechIQ uses API keys issued per organization. Include your key in the Authorization header of every request. Keys are scoped to your organization tenant and can be rotated from the admin console.

Never expose API keys in client-side code or public repositories. Use environment variables and server-side proxy patterns for production integrations.

Bearer token authentication
Organization-scoped API keys
Key rotation without downtime
Separate sandbox and production keys
IP allowlisting available on Enterprise plans

Authorization header http

GET /v1/attendance HTTP/1.1
Host: api.softtechiq.com
Authorization: Bearer sk_live_your_api_key
Accept: application/json

Quick Start

Make your first API call in minutes.

Follow these steps to connect to the SoftTechIQ API and retrieve your first attendance record.

1 Request API credentials from your SoftTechIQ account manager or admin console.
2 Set your API key as an environment variable: SOFTTECHIQ_API_KEY.
3 Send a GET request to /v1/attendance with your Bearer token.
4 Parse the JSON response and integrate with your application.

cURL example bash

curl -X GET "https://api.softtechiq.com/v1/attendance" \
  -H "Authorization: Bearer $SOFTTECHIQ_API_KEY" \
  -H "Accept: application/json"

SDK

Official client libraries for faster integration.

SoftTechIQ is building official SDKs to simplify API integration. SDKs handle authentication, pagination, error handling, and webhook verification out of the box.

PHP SDK — Laravel-first client (coming soon)
JavaScript / TypeScript SDK (coming soon)
Python SDK (planned)
Webhook signature verification helpers
Auto-pagination and retry logic

Official SDK packages will be published to Packagist and npm. Join the waitlist via developer support.

REST API

Core API resources and endpoints.

The REST API exposes platform resources as JSON endpoints. All list endpoints support cursor-based pagination, filtering, and sorting.

GET /v1/attendance List attendance records

GET /v1/attendance/{id} Retrieve a single record

GET /v1/devices List connected devices

GET /v1/devices/{id} Device health and status

GET /v1/events List device events

POST /v1/webhooks Register a webhook endpoint

GET /v1/organization Organization profile and settings

Webhooks

Receive real-time event notifications at your endpoint.

Webhooks deliver device and attendance events to your server in real time. Register an HTTPS endpoint, select event types, and SoftTechIQ will POST signed payloads on every event.

Verify webhook signatures using the signing secret from your admin console to ensure payloads are authentic.

attendance.checked_in — RFID check-in event
attendance.checked_out — Check-out event
device.online — Device came online
device.offline — Device went offline
device.error — Device error reported

Webhook payload example json

{
  "event": "attendance.checked_in",
  "timestamp": "2026-06-29T10:30:00Z",
  "data": {
    "user_id": "usr_123",
    "device_id": "dev_456",
    "location": "Main Gate"
  }
}

Postman Collection

Import ready-made API requests into Postman.

The SoftTechIQ Postman Collection includes pre-configured requests for all API endpoints, environment variables for sandbox and production, and example responses.

All REST API endpoints pre-configured
Sandbox and production environments
Example request and response bodies
Webhook testing helpers

Postman Collection download — coming soon. Contact developer support for early access.

Request Early Access

Rate Limits

API request limits by plan tier.

Rate limits protect platform stability. Limits apply per API key per minute. Exceeded requests receive a 429 response with a Retry-After header.

Plan	Requests / minute	Burst
Starter	60	100
Professional	300	500
Business	1,000	2,000
Enterprise	Custom	Custom

Error Codes

Standard HTTP status codes and API error responses.

The API uses conventional HTTP status codes. Error responses include a JSON body with an error code, message, and optional details array.

Code	Status	Description
200	OK	Request succeeded
201	Created	Resource created successfully
400	Bad Request	Invalid parameters or malformed request
401	Unauthorized	Missing or invalid API key
403	Forbidden	Insufficient permissions for this resource
404	Not Found	Resource does not exist
422	Unprocessable	Validation failed on submitted data
429	Too Many Requests	Rate limit exceeded — check Retry-After header
500	Server Error	Internal error — contact support if persistent

Error response format json

{
  "error": {
    "code": "validation_failed",
    "message": "The given data was invalid.",
    "details": {
      "email": ["The email field is required."]
    }
  }
}

Support

Get help from the SoftTechIQ developer support team.

Our engineering team supports integrators and ISVs building on the SoftTechIQ platform. Reach out for API access, integration guidance, webhook debugging, and enterprise SLAs.

Email: hello@softtechiq.com (developer integrations)
Response within 1–2 business days on standard plans
Priority developer support on Enterprise plans
Integration scoping and architecture reviews
Sandbox credentials for qualified partners

Contact Developer Support → Book Technical Review → Help Center →

Future Developer Portal

What is coming next for SoftTechIQ developers.

We are building a full self-service developer portal with interactive API explorer, sandbox provisioning, SDK downloads, usage analytics, and webhook debugging tools.

Now

REST API access
Webhook delivery
Documentation portal

Interactive API explorer
Postman Collection
PHP & JS SDKs

Future

Self-service sandbox
Usage dashboards
OAuth 2.0 app integrations

Full developer portal with self-service API keys and sandbox — coming soon.

Ready to build, automate, or scale?

Whether you need a SaaS product, custom software, or an IoT solution — our team is ready to help you move forward.

Talk To Our Team Explore Products

Start a Custom Project →

No credit card required · Custom enterprise pricing available