API Access — Integration API for Developers

Overview

UniAsset provides an Integration API that allows external systems — ERPs, IoT pipelines, automation tools, and custom applications — to read and write asset data programmatically.

The API is available on Business and Enterprise plans. IoT signal ingestion requires an Enterprise plan.

---

Plan Requirements

---

Authentication

The Integration API uses API key authentication with Bearer tokens.

Header format:

Authorization: Bearer ua_live_<your-key>
Content-Type: application/json

API keys are created and managed in Settings → Integrations → API Keys. Only users with the Owner role can create or revoke keys.

When you create a key, the full key is shown once only. UniAsset stores a bcrypt hash — the plaintext is never stored or recoverable. Copy your key immediately and store it in a secrets manager (Azure Key Vault, AWS Secrets Manager, etc.).

---

Available Endpoints

All endpoints are write-only in the current release. Read endpoints are planned in a future phase.

---

Getting Started

1. Upgrade to Business plan (or Enterprise for IoT signals).
2. Log in as the Owner.
3. Go to Settings → Integrations → API Keys.
4. Click Create API Key.
5. Enter a descriptive name (e.g. ERP Integration — Production).
6. Select only the permissions your integration needs.
7. Click Generate. Copy the key immediately.
8. Store the key in your secrets manager.
9. Include the key as Authorization: Bearer <key> on every API request.

---

Payload Examples and Field Reference

For complete request/response schemas, required fields, constraints, and error codes, see the Developer Guide inside Settings → Integrations → Developer Guide.

The canonical payload reference is also maintained at /docs/VALIDATED_API_PAYLOAD_REFERENCE.md in the project repository.

---

Security Best Practices

• Create one key per integration (not one key for everything)
• Grant only the permissions each integration actually needs (least-privilege)
• Store keys in a secrets manager — never in source code or environment variable files committed to version control
• Rotate keys on a regular schedule or immediately on suspected exposure
• Revoke keys that are no longer in use

---

Webhooks

UniAsset can also push events to your systems when asset data changes. See Settings → Integrations → Webhooks to configure outbound webhooks.

Available events include asset creation, assignment changes, maintenance records, warranty expiry, document expiry, and incidents. For webhook security and signature verification, see Webhook Security Verification.

---

Error Codes

---

Related Articles

• Webhook Security Verification
• Connecting Azure IoT Hub to UniAsset
• API Security