Tencent Health Card Open Platform

https://open.tengmed.com/openAccess/docs/
Admin
Tencent Health Card Open Platform is an open API platform for healthcare institutions to manage...
Tokens:2,463
Snippets:6
Trust Score:6.2
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get App Token API

Source: https://open.tengmed.com/openAccess/docs/develop#57

This API retrieves a unique application token (appToken) required for authenticating and authorizing subsequent API calls to the Tengmed Health Open Platform. The appToken is a global unique interface call credential and is a mandatory common parameter for most operations.

```APIDOC
## POST /rest/auth/HealthCard/HealthOpenAuth/AuthObj/getAppToken

### Description
This endpoint retrieves a unique application token (appToken) which is a global unique interface call credential. The appToken is a mandatory common parameter for other API calls and needs to be maintained properly. It is recommended to use a central server to manage and refresh the appToken to avoid conflicts.

### Method
POST

### Endpoint
https://p-healthopen.tengmed.com/rest/auth/HealthCard/HealthOpenAuth/AuthObj/getAppToken

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **commonIn** (object) - Required - Common input parameters structure.
  - **appToken** (string) - Optional - The application token. Can be empty when requesting a new token.
  - **requestId** (string) - Required - Unique identifier for the request.
  - **hospitalId** (string) - Required - Identifier for the hospital.
  - **timestamp** (string) - Required - Timestamp of the request.
  - **channelNum** (integer) - Required - Channel number.
  - **sign** (string) - Required - Signature for the request.
- **req** (object) - Required - Request-specific parameters.
  - **appId** (string) - Required - The appId assigned by the open platform.

### Request Example
```json
{
  "commonIn":  
  {
    "appToken": "",
    "requestId": "E856812660584E208D7421E1CAACE8C3",
    "hospitalId": "10086",
    "timestamp": "1525392000",
    "channelNum": 0,
    "sign": "Q5vp1tdaHjuQpDK8yuDOAzFKTOQs5PxgzhLbxMpnadE="
  },
  "req":  
  {
    "appId": "d7656ef9ab5eb27c01724cd3707xxxxx"
  }
}
```

### Response
#### Success Response (200)
- **commonOut** (object) - Common output parameters.
  - **requestId** (string) - Unique identifier for the request.
  - **resultCode** (integer) - Result code of the operation (0 for success).
  - **errMsg** (string) - Error message if any.
- **rsp** (object) - Response-specific parameters.
  - **appToken** (string) - Required - The obtained application token.
  - **expiresIn** (integer) - Required - The validity period of the appToken in seconds (default is 7200).

#### Response Example
```json
{
  "commonOut":  
  {
    "requestId": "E856812660584E208D7421E1CAACE8C3",
    "resultCode": 0,
    "errMsg": "success"
  },
  "rsp":  
  {
    "appToken": "9A60D3D561E4ADBA89ACD9FBF2FB8D2C",
    "expiresIn": 7200
  }
}
```

### SDK Call Examples
#### Java SDK
```java
package test;

import com.alibaba.fastjson.JSONObject;
import com.tencent.healthcard.impl.HealthCardServerImpl;
import com.tencent.healthcard.model.CommonIn;
import java.util.UUID;

public class Test_appToken {
    public static void main(String[] args) {
        // appSecret
        String appSecret = "0626b6e57b68a2c65643a4ba4e0xxxxx";
        HealthCardServerImpl healthCard = new HealthCardServerImpl(appSecret);

        // Construct common input parameters commonIn
        String appToken = "";
        String requestId = UUID.randomUUID().toString().replaceAll("-", "").toUpperCase();
        String hospitalId = "20012";
        int channelNum = 0;
        CommonIn commonIn = new CommonIn(appToken, requestId, hospitalId, channelNum);

        // Construct request parameters req
        String appId = "e8e8974e9831185acf2fcec1e15xxxxx";

        // Call the interface
        JSONObject appTokenObj = healthCard.getAppToken(commonIn, appId);

        // Print the response
        System.out.println("appToken:" + appTokenObj.toJSONString());
    }
}
```

#### C# SDK
```csharp
var iSVOpenInterfaceProxy = new com.tencent.healthcard.HealthOpenAuth.ISVOpenInterfaceProxy {
    domain = "p-healthopen.tengmed.com",
    appSecret = ""
};

var tokenResult = iSVOpenInterfaceProxy.GetAppToken(new com.tencent.healthcard.HealthOpenAuth.CommonIn {
    requestId = System.Guid.NewGuid().ToString(),
    hospitalId = ""
}, new GetAppTokenReq {
    appId = ""
});

var commonOut = (com.tencent.healthcard.HealthOpenAuth.CommonOut)tokenResult["commonOut"];
Assert.IsTrue(commonOut.resultCode == 0, "resultCode must be 0, but found " + commonOut.resultCode.ToString());

var rsp = (GetAppTokenRsp)tokenResult["rsp"];
var appToken = rsp.appToken;
```
```

--------------------------------

### Retrieve API Access Token (appToken)

Source: https://open.tengmed.com/openAccess/docs/develop#57

Demonstrates how to obtain a global access token (appToken) required for subsequent API calls. The token is valid for 7200 seconds and should be managed by a central server to avoid conflicts.

```java
package test;
import com.alibaba.fastjson.JSONObject;
import com.tencent.healthcard.impl.HealthCardServerImpl;
import com.tencent.healthcard.model.CommonIn;
import java.util.UUID;
public class Test_appToken {
public static void main(String[] args) {
String appSecret="0626b6e57b68a2c65643a4ba4e0xxxxx";
HealthCardServerImpl healthCard=new HealthCardServerImpl(appSecret);
String appToken="";
String requestId= UUID.randomUUID().toString().replaceAll("-", "").toUpperCase();
String hospitalId="20012";
int channelNum=0;
CommonIn commonIn=new CommonIn(appToken,requestId,hospitalId,channelNum);
String appId="e8e8974e9831185acf2fcec1e15xxxxx";
JSONObject appTokenObj=healthCard.getAppToken(commonIn,appId);
System.out.println("appToken:"+appTokenObj.toJSONString());
}
}
```

```csharp
var iSVOpenInterfaceProxy = new com.tencent.healthcard.HealthOpenAuth.ISVOpenInterfaceProxy {
domain = "p-healthopen.tengmed.com",
appSecret = ""
};
var tokenResult = iSVOpenInterfaceProxy.GetAppToken(new com.tencent.healthcard.HealthOpenAuth.CommonIn {
requestId = System.Guid.NewGuid().ToString(),
hospitalId = ""
}, new GetAppTokenReq {
appId = ""
});
var commonOut = (com.tencent.healthcard.HealthOpenAuth.CommonOut)(tokenResult["commonOut"]);
Assert.IsTrue(commonOut.resultCode == 0, "resultCode must be 0, but found " + commonOut.resultCode.ToString());
var rsp = (GetAppTokenRsp) tokenResult["rsp"];
var appToken = rsp.appToken;
```
Tokens:
Raw