REST API Developer Portal

Explore the Cien ERP API, learn how to authenticate, and test endpoints in our built‑in console. Switch between sandbox and live modes to validate integrations before going to production.

Auth: Bearer & API key headers Tenant‑aware & rate limited

Overview & Base URLs

All APIs are JSON‑based and served over HTTPS. Use the appropriate base URL for your environment, and pass credentials as documented in the Security & Auth section.

Sandbox

Use sandbox while building and testing your integration.

Base URL – Sandbox

https://www.cienerp.com/api/sandbox

Health Check

GET https://www.cienerp.com/api/sandbox/ping

Live

Switch to the live environment once you are ready for production traffic.

Base URL – Live

https://www.cienerp.com/api

Health Check

GET https://www.cienerp.com/api/ping

Security & Authentication

All requests must be sent over HTTPS and include valid credentials. We support API keys for server‑to‑server calls and Bearer tokens for user‑level access.

API Key Header

System admins generate keys under Settings → Integration Keys.
Include your key in the X-API-Key header on each request.

Example Headers

X-API-Key: <your_api_key>
X-Tenant-ID: <tenant_id>
Accept: application/json

Bearer Token

Obtain a token via your authentication flow (e.g. OAuth2 / JWT endpoint).
Send it as Authorization: Bearer <token> in the header.

Bearer Example

Authorization: Bearer <access_token>
Accept: application/json

Tenant & Permissions

APIs are tenant‑scoped – pass X-Tenant-ID or use a token bound to a tenant.
Permissions mirror the UI (e.g. it-support.tickets.view, documents.verify).

API Testing Console

Use this built‑in console to send test requests to a sample endpoint and inspect the JSON response. Switch between sandbox and live modes using the toggle at the top of the page.

POST https://www.cienerp.com/public/quote/calculate

Sample: Public quote calculation

Ready.

// Response will appear here

Key API Modules

The backend exposes endpoints for core modules such as IT Support, Documents, Finance, and more. The exact URLs may be versioned (e.g. /api/v1/...) depending on your deployment.

IT Support

List tickets: GET /api/tickets
Create ticket: POST /api/tickets

Documents

List documents: GET /api/documents
Upload document: POST /api/documents (multipart/form‑data)

Finance & POS

Invoices, payments, and POS endpoints follow standard REST patterns.

Errors & Response Format

All APIs respond with JSON. Successful requests return a 2xx status code, and errors return a 4xx or 5xx code with a machine‑readable error body.

Success

200 OK

{
  "status": "success",
  "data": {
    "id": 123,
    "message": "Example payload"
  }
}

Validation Error

422 Unprocessable Entity

{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "Field is required."
    ]
  }
}