Settings

A

Webhook Configuration

XPOS integration endpoint and security key

Set this URL in the XPOS integration / webhook settings.

XPOS will send this key in every payload for authentication.

Developer API Reference

Share this with your XPOS developer

GET

Endpoint

GET

Required Headers

Header Value Description
X-API-KEY xr_live_xxxxxx... Your client's unique API secret
Accept application/json Required for JSON response

Query Parameters

Parameter Required Example
client_key Yes karukajctg
phone Yes 01628692798

Example Response  200 OK

{
  "success": true,
  "customer": {
    "phone": "01628692798"
  },
  "rating": {
    "success_rate": 100,
    "total_orders": 3,
    "successful_orders": 3
  }
}

cURL Example

curl -X GET \
  "https://xrating.ncarllc.com/api/v1/customer-rating?client_key=YOUR_CLIENT_KEY&phone=01XXXXXXXXX" \
  -H "Accept: application/json" \
  -H "X-API-KEY: YOUR_API_SECRET"

Important for the XPOS Developer

The X-API-KEY is per-client — each vendor gets their own unique API key from the Clients page. The client_key is their short identifier (e.g. karukajctg).