# Customer/Open API

## Downgrade API

> version=0.0.1\
> bizType=customer.app.CustomerApiWebService.downgrade\
> Accessible after login

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.downgrade":{"post":{"summary":"Downgrade API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.downgrade\nAccessible after login","operationId":"applyApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiKey":{"type":"string","description":"Customer ApiKey"},"tag":{"type":"string","description":"API tags"},"times":{"type":"string","description":"Type of package duration. month－month; year－year; quarter－one season; half－six months;"}},"required":["apiKey","tag","times"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status return code"},"msg":{"type":"string","description":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"data":{"type":"object","description":"Data Body","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}}
```

## Apply API

> version=0.0.1\
> bizType=customer.app.CustomerApiWebService.applyApi\
> Accessible after login

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.applyApi":{"post":{"summary":"Apply API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.applyApi\nAccessible after login","operationId":"applyApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tag":{"type":"string","description":"API tag"},"googleCode":{"type":"string","description":"Google Verification Code"},"phoneCode":{"type":"string","description":"Mobile verification code, email verification code are required"},"emailCode":{"type":"string","description":"Mobile verification code, email verification code are required"},"phoneSendToken":{"type":"string","description":"Send mobile verification code to return token, phoneCode must be passed when not empty"},"emailSendToken":{"type":"string","description":"Send email verification code to return token, emailCode must be passed when not empty"}},"required":["tag"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status return code"},"msg":{"type":"string","description":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"data":{"type":"object","description":"Data Body","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}}
```

## Delete API

> version=0.0.1\
> bizType=customer.app.CustomerApiWebService.delApi\
> Accessible after login

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.delApi":{"post":{"summary":"Delete API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.delApi\nAccessible after login","operationId":"delApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"api id"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status return code"},"msg":{"type":"string","description":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"data":{"type":"object","description":"Data Body","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}}
```

## Allocate permissions

> version=0.0.1\
> bizType=customer.app.CustomerApiWebService.editApiPermission\
> Accessible after login

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.editApiPermission":{"post":{"summary":"Allocate permissions","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.editApiPermission\nAccessible after login","operationId":"editApiPermission","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"API ID"},"googleCode":{"type":"string","description":"Google Verification Code"},"tag":{"type":"string","description":"API tag, cannot be duplicated"},"permissionList":{"type":"array","description":"Enable permission","items":{"type":"object","properties":{"code":{"type":"string","description":"Permission code"},"status":{"type":"integer","format":"int32","description":"Whether to enable 1. Enable 2. Disable"}},"required":["status"]}},"whiteIps":{"type":"string","description":"Whitelist IP, bound IP address, separated by commas"},"phoneCode":{"type":"string","description":"Mobile verification code, email verification code are required"},"emailCode":{"type":"string","description":"Mobile verification code, email verification code are required"},"phoneSendToken":{"type":"string","description":"Send mobile verification code to return token, phoneCode must be passed when not empty"},"emailSendToken":{"type":"string","description":"Send email verification code to return token, emailCode must be passed when not empty"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status return code"},"msg":{"type":"string","description":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"data":{"type":"object","description":"Data Body","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}}
```

## API list

> version=0.0.1\
> bizType=customer.app.CustomerApiWebService.page\
> Access after login

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.page":{"post":{"summary":"API list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.page\nAccess after login","operationId":"page","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"size":{"type":"integer","format":"int64","description":"Number of Items per Page"},"current":{"type":"integer","format":"int64","description":"Current Page"},"tag":{"type":"string","description":"API tag"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status return code"},"msg":{"type":"string","description":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"data":{"type":"object","properties":{"records":{"type":"array","description":"Result list","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique ID corresponding to this API"},"createTime":{"type":"integer","format":"int64","description":"Creation time / Application time"},"updateTime":{"type":"integer","format":"int64","description":"Update Time"},"apiKey":{"type":"string","description":"access Key"},"customerNo":{"type":"string","description":"customerNo"},"customerId":{"type":"integer","format":"int64","description":"Client ID"},"customerGroupId":{"type":"integer","format":"int64","description":"Client group ID"},"companyId":{"type":"integer","format":"int64","description":"companyId"},"secretKeyMd5":{"type":"string","description":"secretKeyMd5"},"privateKey":{"type":"string","description":"secretKey, only returned when applied for"},"pubKey":{"type":"string","description":"Public key"},"tag":{"type":"string","description":"Tag"},"permissionDTOList":{"type":"array","description":"List of permissions","items":{"$ref":"#/components/schemas/CustomerApiPermissionDTO"}},"ipLimit":{"type":"boolean","description":"Whether IP restriction is enabled"},"whiteIps":{"type":"string","description":"IP whitelist"},"sources":{"type":"array","description":"Permission paths allowed to access","items":{"type":"string"}},"expiredTime":{"type":"integer","format":"int64","description":"Expiration time"},"withdrawTime":{"type":"integer","format":"int64"},"validityDays":{"type":"integer","format":"int32","description":"Validity period (days) -1 expired null permanently valid,"}}}},"total":{"type":"integer","format":"int64","description":"Total"},"size":{"type":"integer","format":"int64","description":"Number of Items per Page"},"current":{"type":"integer","format":"int64","description":"Current Page"}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"CustomerApiPermissionDTO":{"type":"object","required":["status"],"properties":{"code":{"type":"string","description":"Permission code"},"name":{"type":"string","description":"Permission name"},"status":{"type":"integer","format":"int32","description":"Whether to enable 1. Enable 2. Disable"},"canEdit":{"type":"boolean","description":"Can it be edited"},"paths":{"type":"array","description":"Permission path","items":{"type":"string"}}}}}}}
```

## API details

> version=0.0.1\
> bizType=customer.app.CustomerApiWebService.queryApi\
> Accessible after login

```json
{"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/Open API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.queryApi":{"post":{"summary":"API details","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.queryApi\nAccessible after login","operationId":"queryApi","tags":["Customer/Open API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"API Id"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerApiVO"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultCustomerApiVO":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status return code"},"msg":{"type":"string","description":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"data":{"$ref":"#/components/schemas/CustomerApiVO"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"CustomerApiVO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"id"},"createTime":{"type":"integer","format":"int64","description":"Creation time / Application time"},"updateTime":{"type":"integer","format":"int64","description":"Update Time"},"apiKey":{"type":"string","description":"access Key"},"customerNo":{"type":"string","description":"customerNo"},"customerId":{"type":"integer","format":"int64","description":"Client ID"},"customerGroupId":{"type":"integer","format":"int64","description":"Client group ID"},"companyId":{"type":"integer","format":"int64","description":"companyId"},"secretKeyMd5":{"type":"string","description":"secretKeyMd5"},"privateKey":{"type":"string","description":"secretKey, only returned when applied for"},"pubKey":{"type":"string","description":"Public key"},"tag":{"type":"string","description":"Tag"},"permissionDTOList":{"type":"array","description":"List of permissions","items":{"$ref":"#/components/schemas/CustomerApiPermissionDTO"}},"ipLimit":{"type":"boolean","description":"Whether IP restriction is enabled"},"whiteIps":{"type":"string","description":"IP whitelist"},"sources":{"type":"array","description":"Permission paths allowed to access","items":{"type":"string"}},"expiredTime":{"type":"integer","format":"int64","description":"Expiration time"},"withdrawTime":{"type":"integer","format":"int64"},"validityDays":{"type":"integer","format":"int32","description":"Validity period (days) -1 expired null permanently valid,"}}},"CustomerApiPermissionDTO":{"type":"object","required":["status"],"properties":{"code":{"type":"string","description":"Permission code"},"name":{"type":"string","description":"Permission name"},"status":{"type":"integer","format":"int32","description":"Whether to enable 1. Enable 2. Disable"},"canEdit":{"type":"boolean","description":"Can it be edited"},"paths":{"type":"array","description":"Permission path","items":{"type":"string"}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.multimarkets.org/client-api/more.../customer-open-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.