How to connect
1. Apply for access
Contact our commercial team to obtain a merchant account number and key.
2. CRM backend
- Test Service:
https://test-crm.mcconnects.com/ - Prod Service:
https://crm.mcconnects.com/
3. API Address
- Test Service:
https://test-gateway.mcconnects.com/mc-crm/ - Prod Service:
https://gateway.mcconnects.com/mc-crm/
4. Agreements & Norms
-
Request method: POST
-
Request parameters: JSON
-
Encoding format: UTF-8
-
Request message structure: The api will process two types of content in the request: Header (public parameters, stored in the HTTP headers attribute), Body (private parameters, stored in the HTTP headers attribute) Body attribute)
-
Element appearance requirements:
Symbol Description R This element must appear in the message (Required) O This element is optional in the message (Optional) C This element in the message appears under certain conditions (Conditional) -
Public parameters:
Public parameters (Header) are parameters used to identify products and interface authentication. These parameters need to be carried in the headers attribute of each request:
| Parameter name | Type | Occurrence requirements | Description |
|---|---|---|---|
| token | string | R | Access-Token generated after creating a merchant on the platform |
- Response message structure:
All interface responses are in JSON format. Unless otherwise specified, the return value of each request contains the following fields:
| Parameter name | Type | Occurrence requirements | Description |
|---|---|---|---|
| code | int | R | Response code, please see "Appendix A Response Code Description" for code definition |
| msg | string | R | response description |
| data | object | R | Parameters unique to each interface, see each interface definition for details |
Example
{
"code": 200,
"msg": "调用成功",
"data": {
"Channel": "A10086",
"Type": 7004
}
}
Appendix A Description of Response Codes
| Response code | Description |
|---|---|
| 200 | Call succeeded |
| 303 | Parameter error |
| 500 | Error |