{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-ecd/describe-benefits":{"post":{"operationId":"cloud_aliyun_ecd_describe_benefits","summary":"Queries the benefit specifications, benefit quantities, and other information associated with a channel.…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://ecd.ap-northeast-1.aliyuncs.com","https://ecd.ap-southeast-1.aliyuncs.com","https://ecd.ap-southeast-5.aliyuncs.com","https://ecd.ap-southeast-6.aliyuncs.com","https://ecd.ap-southeast-7.aliyuncs.com","https://ecd.cn-beijing.aliyuncs.com","https://ecd.cn-chengdu.aliyuncs.com","https://ecd.cn-guangzhou.aliyuncs.com","https://ecd.cn-hangzhou-finance.aliyuncs.com","https://ecd.cn-hangzhou.aliyuncs.com","https://ecd.cn-hongkong.aliyuncs.com","https://ecd.cn-nanjing.aliyuncs.com","https://ecd.cn-qingdao.aliyuncs.com","https://ecd.cn-shanghai-finance-1.aliyuncs.com","https://ecd.cn-shanghai.aliyuncs.com","https://ecd.cn-shenzhen.aliyuncs.com","https://ecd.cn-wulanchabu.aliyuncs.com","https://ecd.cn-zhangjiakou.aliyuncs.com","https://ecd.eu-central-1.aliyuncs.com","https://ecd.eu-west-1.aliyuncs.com","https://ecd.me-central-1.aliyuncs.com","https://ecd.me-east-1.aliyuncs.com","https://ecd.us-east-1.aliyuncs.com","https://ecd.us-west-1.aliyuncs.com"],"default":"https://ecd.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://ecd.ap-southeast-1.aliyuncs.com"},"ChannelId":{"type":"string","description":"The ID of the channel. The target channel for querying benefits"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-ecd/get-redeem-codes":{"post":{"operationId":"cloud_aliyun_ecd_get_redeem_codes","summary":"Retrieves benefit redemption codes. Channel benefits are issued and transferred as redemption codes. After…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CodeQuantity","BenefitId","RequestToken"],"properties":{"endpoint":{"type":"string","enum":["https://ecd.ap-northeast-1.aliyuncs.com","https://ecd.ap-southeast-1.aliyuncs.com","https://ecd.ap-southeast-5.aliyuncs.com","https://ecd.ap-southeast-6.aliyuncs.com","https://ecd.ap-southeast-7.aliyuncs.com","https://ecd.cn-beijing.aliyuncs.com","https://ecd.cn-chengdu.aliyuncs.com","https://ecd.cn-guangzhou.aliyuncs.com","https://ecd.cn-hangzhou-finance.aliyuncs.com","https://ecd.cn-hangzhou.aliyuncs.com","https://ecd.cn-hongkong.aliyuncs.com","https://ecd.cn-nanjing.aliyuncs.com","https://ecd.cn-qingdao.aliyuncs.com","https://ecd.cn-shanghai-finance-1.aliyuncs.com","https://ecd.cn-shanghai.aliyuncs.com","https://ecd.cn-shenzhen.aliyuncs.com","https://ecd.cn-wulanchabu.aliyuncs.com","https://ecd.cn-zhangjiakou.aliyuncs.com","https://ecd.eu-central-1.aliyuncs.com","https://ecd.eu-west-1.aliyuncs.com","https://ecd.me-central-1.aliyuncs.com","https://ecd.me-east-1.aliyuncs.com","https://ecd.us-east-1.aliyuncs.com","https://ecd.us-west-1.aliyuncs.com"],"default":"https://ecd.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://ecd.ap-southeast-1.aliyuncs.com"},"CodeQuantity":{"type":"integer","description":"The number of redemption codes required. Valid values: 1 to 100"},"BenefitId":{"type":"string","description":"The ID of the benefit included in the redemption codes. You can call https://help.aliyun.com/document_detail/2500858.html to obtain the…"},"RequestToken":{"type":"string","description":"The channel service request token. You can call https://help.aliyun.com/document_detail/2500860.html to obtain the token. Each channel…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-ecd/get-request-token":{"post":{"operationId":"cloud_aliyun_ecd_get_request_token","summary":"Retrieves a one-time credential for channel service requests. The credential can be used to authenticate…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ChannelId"],"properties":{"endpoint":{"type":"string","enum":["https://ecd.ap-northeast-1.aliyuncs.com","https://ecd.ap-southeast-1.aliyuncs.com","https://ecd.ap-southeast-5.aliyuncs.com","https://ecd.ap-southeast-6.aliyuncs.com","https://ecd.ap-southeast-7.aliyuncs.com","https://ecd.cn-beijing.aliyuncs.com","https://ecd.cn-chengdu.aliyuncs.com","https://ecd.cn-guangzhou.aliyuncs.com","https://ecd.cn-hangzhou-finance.aliyuncs.com","https://ecd.cn-hangzhou.aliyuncs.com","https://ecd.cn-hongkong.aliyuncs.com","https://ecd.cn-nanjing.aliyuncs.com","https://ecd.cn-qingdao.aliyuncs.com","https://ecd.cn-shanghai-finance-1.aliyuncs.com","https://ecd.cn-shanghai.aliyuncs.com","https://ecd.cn-shenzhen.aliyuncs.com","https://ecd.cn-wulanchabu.aliyuncs.com","https://ecd.cn-zhangjiakou.aliyuncs.com","https://ecd.eu-central-1.aliyuncs.com","https://ecd.eu-west-1.aliyuncs.com","https://ecd.me-central-1.aliyuncs.com","https://ecd.me-east-1.aliyuncs.com","https://ecd.us-east-1.aliyuncs.com","https://ecd.us-west-1.aliyuncs.com"],"default":"https://ecd.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://ecd.ap-southeast-1.aliyuncs.com"},"ChannelId":{"type":"string","description":"The channel ID. The channel service request credential is valid only for this channel"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-ecd/version":{"post":{"operationId":"cloud_aliyun_ecd_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ecd.ap-northeast-1.aliyuncs.com","https://ecd.ap-southeast-1.aliyuncs.com","https://ecd.ap-southeast-5.aliyuncs.com","https://ecd.ap-southeast-6.aliyuncs.com","https://ecd.ap-southeast-7.aliyuncs.com","https://ecd.cn-beijing.aliyuncs.com","https://ecd.cn-chengdu.aliyuncs.com","https://ecd.cn-guangzhou.aliyuncs.com","https://ecd.cn-hangzhou-finance.aliyuncs.com","https://ecd.cn-hangzhou.aliyuncs.com","https://ecd.cn-hongkong.aliyuncs.com","https://ecd.cn-nanjing.aliyuncs.com","https://ecd.cn-qingdao.aliyuncs.com","https://ecd.cn-shanghai-finance-1.aliyuncs.com","https://ecd.cn-shanghai.aliyuncs.com","https://ecd.cn-shenzhen.aliyuncs.com","https://ecd.cn-wulanchabu.aliyuncs.com","https://ecd.cn-zhangjiakou.aliyuncs.com","https://ecd.eu-central-1.aliyuncs.com","https://ecd.eu-west-1.aliyuncs.com","https://ecd.me-central-1.aliyuncs.com","https://ecd.me-east-1.aliyuncs.com","https://ecd.us-east-1.aliyuncs.com","https://ecd.us-west-1.aliyuncs.com"],"default":"https://ecd.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://ecd.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}