Authentication

The Ekomium Company API uses JSON-RPC authentication. There are no separate API keys. You authenticate with an Ekomium user account created by Ekomium.

Step 1: Authenticate

curl -X POST https://your-company.ekomium.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "method": "call",
    "params": {
      "service": "common",
      "method": "authenticate",
      "args": ["your_database", "[email protected]", "your_password", {}]
    },
    "id": 1
  }'

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": 2
}

The result is your UID token. Pass it in all subsequent execute_kw calls along with the same password. The API Playground saves this token automatically after login.

Step 2: Call API methods

Use execute_kw with your database, UID token, password, model, method, and arguments.

Recommended users

Role	Ekomium group	Use
Integration read-only	POS User	Sync sales & catalog
Integration admin	POS Administrator	Full POS data access

Ask Ekomium to create a dedicated integration user with minimal required permissions.

Security notes

• Always use HTTPS
• Store credentials securely (never in client-side code)
• Use read-only users when possible
• Rate-limit your integration (recommended: max 60 req/min)

Test authentication

Use the API Playground. Select POST /api/v1/auth/login and enter your credentials. The token is saved for subsequent endpoint tests.