TipsoiDevelopers
Home / Guide / Quick Start

Quick Start

From zero to your first authenticated API call. This uses the Software (HRM) API; the Device Portal API follows the same shape with a username login.

Before you start

You’ll need API credentials from Tipsoi (see Get Access) and any HTTP client. Every request is authenticated with a JWT bearer token — no API keys to manage.

1 · Get a token

Exchange your credentials for a JWT at POST /auth/external-sync/sign-in.

Sign in — cURL
curl -X POST \
  "https://test.clients.inovacetech.com/inovace-client/api/v1/auth/external-sync/sign-in" \
  -H "Content-Type: application/json" \
  -d '{"email":"api@tipsoi.ai","password":"YOUR_PASSWORD"}'

A successful response returns the token you’ll send on every subsequent request:

200 OK
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 3600
}
Keep the token server-side. Never commit it or expose it in client code or URLs.

2 · Make your first call

Send the token in the Authorization header. This lists employees:

List employees — cURL
curl -X GET \
  "https://test.clients.inovacetech.com/inovace-client/api/v1/employee" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

That’s the pattern for all 83 Software API endpoints — authenticate once, then call any resource. Browse them all in the Software API reference, each with a live request console.

3 · Understand errors

Errors come back as a consistent JSON object with an HTTP status code:

Error shape
{
  "code": 401,
  "context": "authentication",
  "message": "failed to authenticate"
}

Common codes: 200 success, 201 created, 400 bad request, 401 unauthorized, 404 not found, 422 validation error, 500 server error.

Where to go next

← Previous
Sandbox
Next →
Device SDK