RESTful API v2.4 (Latest) API Gateway Operational

API Documentation

Secure APIs for integrating your ERP with third-party applications. High-performance REST endpoints, Webhook events, and comprehensive developer SDKs.

Base Production URL HTTPS
https://api.erp.system/v2 JSON
Rate Limit: 1000 req/min Format: UTF-8 JSON
Security Protocols

Authentication

Enterprise-grade security standards protecting every API request and response payload.

🔑

API Keys

Generate scoped API keys via the admin panel. Include the key in the request header for server-to-server microservice communication.

X-ERP-API-Key: erp_live_...
🛡️

OAuth 2.0

Standard OAuth2 Authorization Code flow with PKCE support for third-party user consent and delegated permissions.

/oauth/authorize?response_type=code
🔐

JWT Tokens

Short-lived Bearer tokens signed with RS256 algorithm. Contains encrypted tenant claims and user role scopes.

Authorization: Bearer eyJ...
🌐

Security & IP Limits

Enforce IP whitelisting per API key, HMAC signature verification for webhooks, and automatic TLS 1.3 encryption.

X-Signature-256: hmac_sha256
Resource Catalog

API Endpoints

Core JSON REST endpoints available for managing enterprise data models.

GET / POST

Employees API

Query employee records, create new hire profiles, update department mappings, and retrieve biometric attendance logs.

GET /v2/employees List All Employees
POST /v2/employees Create Record
GET /v2/employees/{id}/attendance Fetch Logs
GET / PUT

Customers API

Manage B2B/B2C accounts, sync customer billing addresses, fetch open invoices, and track lifetime order values.

GET /v2/customers Query Accounts
PUT /v2/customers/{id} Update Profile
GET /v2/customers/{id}/invoices Customer Invoices
POST / GET

Payroll API

Trigger automated payroll runs, fetch calculated tax breakdowns, retrieve individual payslip PDFs, and audit disbursements.

POST /v2/payroll/process Run Payroll
GET /v2/payroll/runs/{id} Payroll Details
GET /v2/payroll/slips/{id}.pdf Payslip Stream
GET / POST

Inventory API

Real-time stock level synchronization, warehouse transfer adjustments, serial number lookups, and reorder alerts.

GET /v2/inventory/items SKU Inventory
POST /v2/inventory/adjustments Stock Shift
GET /v2/inventory/warehouses Warehouse List
Interactive Snippets

Code Examples

Ready-to-use code snippets in popular languages to accelerate your implementation.

<?php
// Fetch list of active employees using PHP cURL
$ch = curl_init('https://api.erp.system/v2/employees?status=active');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

print_r($data);
use Illuminate\Support\Facades\Http;

// Using Laravel HTTP Client to fetch customer details
$response = Http::withToken('YOUR_API_TOKEN')
    ->withHeaders(['X-ERP-API-Key' => config('services.erp.key')])
    ->get('https://api.erp.system/v2/customers', [
        'page' => 1,
        'per_page' => 25
    ]);

if ($response->successful()) {
    $customers = $response->json('data');
}
// Modern Async Fetch API for Inventory SKU Query
async function fetchInventory() {
  const response = await fetch('https://api.erp.system/v2/inventory/items', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_TOKEN',
      'Content-Type': 'application/json'
    }
  });

  const result = await response.json();
  console.log(result.data);
}
import requests

# Query Payroll Run status using Python Requests
url = "https://api.erp.system/v2/payroll/runs"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
payroll_data = response.json()
print(payroll_data)
Testing & Debugging

Developer Tools

OpenAPI spec, Postman environment templates, error matrix, and rate limiting details.

📖

Swagger UI

Interactive OpenAPI 3.0 specification explorer to test API calls in your browser.

Launch Swagger UI →
🚀

Postman Collection

Download v2.1 Postman collection with pre-built environment variables and tests.

Download Collection (JSON)
⚠️

Error Codes

HTTP status code matrix (400, 401, 422, 429, 500) and error envelope schema.

View Error Dictionary
📊

Rate Limits

Learn about response headers, burst limits, retry policies, and quota increases.

Rate Limiting Rules
Developer Sandbox Ready

Start integrating your ERP today.

Generate sandbox credentials in seconds and explore our robust REST API infrastructure with dedicated developer support.

💻

Developer Slack & Discord

Join 5,000+ developers building ERP extensions.

API SLA & Uptime

99.99% guaranteed API Gateway availability.

🛡️

Custom Endpoints

Enterprise plans include custom API endpoint creation.