API Authentication & Tokens

All API requests require authentication using your API token.

Sending Your Token

Include your token in the request header using one of these methods:

Method 1: Authorization Header (Recommended)

Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4

Method 2: X-API-Key Header

X-API-Key: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4

curl -X GET "https://www.HomaCRM.com/api/v1/external/auth/verify" \
  -H "X-API-Key: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -H "Accept: application/json"

Note: Your API token does not expire. However, regenerating a new token will invalidate the previous one immediately.

Verify Token Endpoint

GET /auth/verify

Verify your token and get user information and permissions.

Example

curl -X GET "https://www.HomaCRM.com/api/v1/external/auth/verify" \
  -H "Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -H "Accept: application/json"

Response

{
  "success": true,
  "data": {
    "portalCode": "10003385",
    "userId": 10042,
    "isMainAdmin": true,
    "scopes": [
      "messaging:send",
      "messaging:credit:read",
      "messaging:numbers:read",
      "messaging:reports:read",
      "messaging:drafts:read",
      "messaging:drafts:write",
      "crm:contacts:read",
      "crm:contacts:write",
      "support:tickets:read",
      "support:tickets:write"
    ]
  }
}

مدیریت مشتریان

عملیات مالی