This is the API descriptor for the Nomad CBEC, responsible for CBEC customer ID check.
Developed by 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

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


Responses
  • 200 string

    BBC order service health status

GET /health
curl \
 -X GET https://nomad.samarkand-global.cn/cbec/health

Id

IdCheck

Check if the user is valid.

Query parameters
  • user_id Required / string

    Customer ID

  • name Required / string

    Customer Name

  • cache string

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

Responses
  • 200 object

    User ID and Name has been checked successfully.

    • code integer(int32)
    • message string
    • data object

      userValid is true if ID and Name is all validated.

    • error string

      error message.

  • 400

    Invalid input.

  • 404

    id check failed.

  • 500 object

    id retrieval failed.

    • code integer(int32)
    • message string
    • data object

      userValid is true if ID and Name is all validated.

    • error string

      error message.

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"
}

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