Nomad CBEC
1.5.1

This is the API descriptor for the Nomad CBEC, responsible for CBEC customer ID check.
Developed by Samarkand Global <https://samarkand.global>_

This is the documentation for version 1.5.1 of the API. Last update on Nov 1, 2021.

Base URL 
https://nomad.samarkand-global.cn/cbec

Authentication

Ca key (http_api_key)

Send an authentication token in the Authorization query parameter to authenticate with the API.

health

API for health metrics

Health

GET /health

Responses

  • • 200 string

    BBC order service health status

GET /health 
curl \
 -X GET https://nomad.samarkand-global.cn/cbec/health
Response example (200) 
"string"

Metrics

GET /metrics

Responses

  • • 200 string

    BBC order cancel successed

  • • 400

    Invalid input

  • • 401

    Unauthorized: provided apikey is not valid

  • • 500

    Server error

GET /metrics 
curl \
 -X GET https://nomad.samarkand-global.cn/cbec/metrics
Response example (200) 
"string"

user

IdCheck

GET /id
Ca key

Check if the user is valid.

Query parameters

  • user_id string Required

    Customer ID

  • name string Required

    Customer Name

  • cache string

    Cache that customer ID and name is matched. If the value is disable, the cache will not be checked

Responses

GET /id 
curl \
 -X GET https://nomad.samarkand-global.cn/cbec/id?user_id=string&name=string&Authorization=api_token_value
Response example (200) 
{
  "code": 42,
  "message": "string",
  "data": {
    "userValid": false
  },
  "error": "string"
}
Response example (500) 
{
  "code": 42,
  "message": "string",
  "data": {
    "userValid": false
  },
  "error": "string"
}