API Integration

Learn how to integrate with Assignar Pay using our REST API and API keys

API Integration Features

Integrate Assignar Pay with your existing systems and build custom applications using our RESTful API. Access payroll data, manage pay rates, and automate workflows programmatically.

Core API Features

API Keys

Secure authentication for API access. Learn how to:

Create and manage API keys with granular permissions
Set expiration dates and security scopes
Use API keys in your applications
Revoke keys when needed

API Documentation

Interactive API documentation with:

Complete endpoint reference
Request and response schemas
Try-it-out functionality
Authentication examples

Getting Started

New to the Assignar Pay API? Start with:

API Keys - Create your first API key
API Documentation - Explore available endpoints
Review authentication requirements and best practices

Authentication

The Assignar Pay API uses API key authentication. You can provide your API key in two ways:

X-API-KEY header: X-API-KEY: sk_your_api_key_here
Authorization Bearer header: Authorization: Bearer sk_your_api_key_here

Both methods are supported, with X-API-KEY taking precedence if both are provided.

API Base URL

All API endpoints are available at:

https://pay.assignar.com/api/v1

Rate Limits

API requests are subject to rate limiting to ensure fair usage. More details coming soon.

Best Practices

Store API keys securely and never commit them to version control
Use environment variables for API key storage
Rotate API keys regularly for security
Set appropriate expiration dates for temporary integrations
Use scoped permissions to limit access to only what's needed
Monitor API key usage and revoke unused keys
Handle rate limits gracefully in your applications

Integration Examples

cURL Example

curl -X GET "https://pay.assignar.com/api/v1/pay-rates" \
  -H "X-API-KEY: sk_your_api_key_here" \
  -H "Content-Type: application/json"

JavaScript/TypeScript Example

const response = await fetch('https://pay.assignar.com/api/v1/pay-rates', {
  headers: {
    'X-API-KEY': process.env.API_KEY,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();

Python Example

import requests

headers = {
    'X-API-KEY': os.environ['API_KEY'],
    'Content-Type': 'application/json',
}

response = requests.get(
    'https://pay.assignar.com/api/v1/pay-rates',
    headers=headers
)

data = response.json()

What's Next

After setting up API access, you may want to:

Explore the API Documentation for available endpoints
Review API Keys for advanced key management
Check Reports to understand the data structure

Core API Features

Secure authentication for API access. Learn how to:

Create and manage API keys with granular permissions

Set expiration dates and security scopes

Use API keys in your applications

Revoke keys when needed

Interactive API documentation with:

Complete endpoint reference

Request and response schemas

Try-it-out functionality

Authentication examples

Best Practices

Store API keys securely and never commit them to version control

Use environment variables for API key storage

Rotate API keys regularly for security

Set appropriate expiration dates for temporary integrations

Use scoped permissions to limit access to only what's needed

Monitor API key usage and revoke unused keys

Handle rate limits gracefully in your applications

Integration Examples

cURL Example

curl -X GET "https://pay.assignar.com/api/v1/pay-rates" \ -H "X-API-KEY: sk_your_api_key_here" \ -H "Content-Type: application/json"

JavaScript/TypeScript Example

const response = await fetch('https://pay.assignar.com/api/v1/pay-rates', { headers: { 'X-API-KEY': process.env.API_KEY, 'Content-Type': 'application/json', }, }); const data = await response.json();

Python Example

import requests headers = { 'X-API-KEY': os.environ['API_KEY'], 'Content-Type': 'application/json', } response = requests.get( 'https://pay.assignar.com/api/v1/pay-rates', headers=headers ) data = response.json()