Calling Protocol
Request
| Request Protocol | HTTPS |
|---|---|
| Character Encoding | UTF-8 |
Request Entry Point
| Region | Entry Point |
|---|---|
| China Region | https://openapi.orionstar.com |
| Europe Region | https://global-openapi.orionstar.com |
| USA Region | https://us-openapi.orionstar.com |
| Japan Region | https://jp-openapi.orionstar.com |
Request URL
- The URL path will be provided in the specific API documentation, which is the part after the entry point. Prepend the entry point of the specific region to the URL path to get the complete request URL;
- Please refer to API List;
- Taking the Get Robot Information API call in the China region as an example:
- Entry Point: https://global-openapi.orionstar.com
- URL Path: /v1/robot/robot_info
Common Request Headers
| Common Request Headers | Description |
|---|---|
| Authorization | Used to pass the access token for the API. Please refer to Authentication Methods. |
| Content-Type |
|
Response
| Content-Type | application/json |
|---|---|
| Character Encoding | UTF-8 |
Common Response Body
| Parameter | Type | Description |
|---|---|---|
| code | int | Error code. 0 means success, non-zero means failure, Please refer to Error Codes. |
| msg | string | Error description. When there is a failure, a specific error description will be provided. |
| req_id | string | Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value. |
| data | object | Business data object, see below for details Response Body Data Object. |
Response Body Data Object
- Different APIs will have different response body data objects, please refer to the specific API documentation;
Common Response Body Example
{ "code": 0, "msg": "", "req_id": "test_req_id", "data": { // Different APIs will have different response body data objects, please refer to the specific API documentation } }