Skip to content

Custom API Howto (zh_CN)

Mariotaku edited this page Jan 12, 2014 · 13 revisions

设定API

设定API需要在登录界面内,因为认证方式复杂,所以必须重新登录。如果不想重新登录,很简单,下载SQLite编辑器自己改。

登录界面

右上角第一个菜单项就是“编辑API”

“编辑API”界面

一般情况下后两项不需要也不能修改

###JTAPI###

这里提供五个公共API用来测试。

https://jtapi-public-1.appspot.com/

https://jtapi-public-2.appspot.com/

https://jtapi-public-3.appspot.com/

https://jtapi-public-4.appspot.com/

https://jtapi-public-5.appspot.com/

假设 "https://myjtapi.appspot.com/" 是你的twip地址。

REST Base URL 设定为 "https://api.myjtapi.appspot.com/1.1/" (不要丢了末尾的 "/" !)

OAuth Base URL 设定为 "https://api.myjtapi.appspot.com/oauth/" (不要丢了末尾的 "/" !)

认证方式选择 "OAuth" 。

点击右上角的扳手进入“设定”-“网络”。启用“忽略SSL错误”(可选:启用“TCP DNS 查询方式”)。

点击“自定义主机映射”,添加一项。第一行写“appspot.com”,第二行写“www.google.com”或者从SmartHosts项目中找到的你喜欢的Google的IP。

###GTAP###

假设 "mygtap" 是你的应用ID。

REST Base URL 设定为 https://mygtap.appspot.com/api/1.1/ (不要丢了末尾的 "/" !)

GTAP 只支持基本的功能,所以你不需要设定其他API地址,即使设定了也没用。

认证方式选择 "Basic" 。

###Twip###

请更新到twip最新版

  • Twip O 模式

假设 "https://example.com/twip/o/password/" 是你获得的API地址。

REST Base URL 设定为 "https://example.com/twip/o/password/1.1/" (不要丢了末尾的 "/" !)

不需要设定其他API地址,认证方式选择 "twip O mode" 。

  • Twip T 模式

假设 "https://example.com/twip/" 是你的twip地址。

REST Base URL 设定为 "https://example.com/twip/t/1.1/" (不要丢了末尾的 "/" !)

OAuth Base URL 设定为 "https://example.com/twip/t/oauth/" (不要丢了末尾的 "/" !)

认证方式选择 "OAuth" 。

搭建API

###jtapi###

  • 假设你部署时想用 myjtapi 作为 AppID。

  • 去 Google App Engine 用 Google Account 账户登录,申请一个新的 app。别的不用管。假设 https://myjtapi.appspot.com/"是你的API地址。

  • 可能需要 Oracle 的 JDK,需要JDK 7以上。

  • 下载并解压 appengine-java-sdk

  • jtapi 的页面,找到 "Download ZIP" 按钮,点击下载最新版,假设最新版为0.4,那么它的整数版本号就是4。

  • 解压,找到 war 目录。因为 war 是我们上传到 App Engine 的程序文件,为了方便起见,我们直接把这个目录复制到 App Engine SDK的目录下。

    • Windows下的部署

    打开命令提示符。(在较新版本的Windows,比如 Window 7/8上,可以直接在解压好的目录里找到 war 目录,按住Shift然后右键单击 - 在命令提示符中打开)

    假设我们把下载好的 appengine-java-sdk-1.8.8.zip 解压到了 D:\ 下面。执行如下命令。

    D:\
    cd appengine-java-sdk-1.8.8
    bin\appcfg.cmd -A myjtapi update war
    bin\appcfg.cmd -A myjtapi set_default_version war 4
    
    • Linux下的部署

    打开终端

    假设我们把下载好的 appengine-java-sdk-1.8.8.zip 解压到了 ~/ 下面。执行如下命令。

    cd ~/appengine-java-sdk-1.8.8
    ./bin/appcfg.sh -A myjtapi update war
    ./bin/appcfg.sh -A myjtapi set_default_version war 4

在提示输入用户名密码时输入后,看到 “Update completed successfully.” 你就成功了,用浏览器打开的话,应该会看到如下内容:

JTAPI 0.4 is running!
--------------------------------
Rest Base URL:		https://api.myjtapi.appspot.com/1.1/
OAuth Base URL: 	https://api.myjtapi.appspot.com/oauth/
--------------------------------
How to use with Twidere:
Enable "Ignore SSL Error", then set above URLs (It's better to use HTTPS.)
--------------------------------
Clone this wiki locally