Overview
The API supports two main scenarios:
Direct user access – A user accesses the API using their own API key.
Company integration – An external company or system accesses the API on behalf of a user via an API client.
1. API Keys
All users can create API keys directly in the system. An API key grants access to read and write data on the user's behalf.
Creating an API Key
API keys are created by authenticating with a username and password. This is the only way to issue a key — no other authentication method is available.
Important: Store your API key securely. It grants full read and write access to your data.
2. API Client (for Companies)
Companies that want to build integrations with the system can apply for an API client. An API client serves as the company's access identity within the system.
An API client alone does not grant access to user or company data. To access data, the client must be combined with one or more API keys.
How It Works
Component | Purpose |
API client | Identifies the integrating company |
API key | Grants access to a specific user's or company's data |
The API client includes the API key in its requests to specify which user or company is being accessed. It is possible to include multiple API keys if the integration requires access to data across several companies.
3. Integrating with Salary
Companies building integrations directly with Salary must use both components:
An API client – issued to the integrating company.
The user's API key – issued by the Salary user whose data the integration will act on behalf of.
The user creates their own API key (via username and password) and shares it with the integrating company, which then includes the key in its API requests alongside its API client.
4. API Documentation
To read and go through the documentation of Salary, please find it here
Summary
User → Logs in with username + password → Create API-keys (red/write access)
Company with integration → Has an API client (company identity) → Includes API key in requests → Accesses one or more users'/companies' data
