Metadata-Version: 2.1
Name: tisdk
Version: 0.1.1
Summary: python sdk of taiqiyun
Home-page: UNKNOWN
License: UNKNOWN
Description: ### 钛旗云 SDK 使用说明
        
        #### Python 版（V1.0）
        
        ##### 说明
        该SDK需使用python3以上版本
        
        ##### 安装 SDK
        
        通过 `pip` 一键完成安装
        
        ```sh
        pip install tisdk -U
        ```
        
        ##### 使用 SDK 调试接口
        
        安装完成后, 可直接在命令行使用 `tireq` 命令调试接口
        
        ```sh
        tireq username secret_key method url [foo:bar,foo2:bar2...]
        ```
        
        `tireq` 命令的参数依次是:
        
        1. 用户名 (由钛旗云系统分配)
        2. 密钥 (由钛旗云系统分配)
        3. 请求方法名 (`get` `post` `put` ...)
        4. 请求 url
        5. 请求体参数 (参数名和参数值以 `:` 相隔, 多对参数之间以 `,` 相隔) **非必须**
        
        参考示例如下
        
        ```sh
        tireq myusername 4fbe6e7084ec4d05 post /api/xxx/v1 name1:value1
        ```
        
        ##### 在代码中调用 SDK 发起请求
        
        参考 `Python` 代码如下
        
        ```python
        import tisdk
        
        username = 'myusername'
        secret_key = '4fbe6e7084ec4d05'
        method = 'post'
        url = '/api/xxx/v1'
        data = {'name1': 'value1'}
        
        # 直接调用 ti_request 方法发起请求
        # 每次发起请求时都传入`用户名`和`密钥`
        tisdk.ti_request(username, secret_key, method, url, data)
        
        # 以`用户名`和`密钥`初始化 Ti 对象
        # 之后调用 Ti.request 方法发起请求, 不需每次传`用户名`和`密钥`
        ti = tisdk.Ti(username, secret_key)
        ti.request(method, url, data)
        
        ```
        
        #### Java [SDKV1.0下载]({{JAVA_SDK_DOWNLOADURL}})
        
        ##### 说明
        
        通过我司提供的 jar 包工具类，可直接生成请求需要的签名和数据的加密或者直接发起请求
        
        **jar 包依赖第三方库 fastjson(1.2以上) 和 httpclient(4.5以上)**
        
        ```xml
        <dependency>
          <groupId>org.apache.httpcomponents</groupId>
          <artifactId>httpclient</artifactId>
          <version>4.5.9</version>
        </dependency>
        <dependency>
          <groupId>com.alibaba</groupId>
          <artifactId>fastjson</artifactId>
          <version>1.2.58</version>
        </dependency>
        ```
        
        ##### jar 包工具类说明
        
        - AesUtils: Aes 加解密工具类
        - HmacSha256: Hmac256 生成工具类
        - RequestUtil： api 请求工具类
        - Ti: 钛旗云 sdk 工具类
        
        ##### 在代码中调用 SDK 发起请求
        
        参考 `Java` 代码如下
        
        ```java
        import com.alibaba.fastjson.JSON;
        import com.kq300061.tisdk.AesUtils;
        import com.kq300061.tisdk.Ti;
        
        import java.util.HashMap;
        import java.util.Map;
        
        public class ReqTest {
            public static void main(String[] args) {
                try {
                    String username = "username";
                    String secret = "secret";
                    String url = "https://XX//api/xxx/v1";
                    HashMap<String, Object> reqbody = new HashMap<String, Object>() {{
                        put("name", "abc");
                        put("phone", "cdf");
                        put("idCard", "123");
                    }};
        
                    // https
                    String resp = new Ti(username, secret).doHttpsPost(url, reqbody);
                    // 或者使用以下这种方式
                    // Ti TiRequest = new Ti(username, secret);
                    // String resp = TiRequest.doHttpsPost(url, reqbody);
                    System.out.println(resp);
        
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        
        }
        ```
Platform: UNKNOWN
Description-Content-Type: text/markdown
