呼び出し制限

ServiceGo オープンインターフェースを使用する際は、以下のルールに従う必要があります：

概要

一般原則

HTTP リクエストメソッド

ServiceGoサービスは、可能な限り標準のHTTPとRESTに近づけるよう努めています。

リクエストメソッド 用途
GET リソースの取得
POST 新しいリソースの作成またはリソースのクエリ
PUT 既存リソースの更新
DELETE 既存リソースの削除

ページネーション

ServiceGoサービスがページネーションで返す必要があるオブジェクトは、以下のメッセージ形式に準拠します。

属性名 型 説明
paging オブジェクト ページネーションオブジェクト
paging.pageNum 整数型 ページ番号
paging.pageSize 整数型 ページサイズ
paging.total 整数型 総数

HTTP ステータスコード

ServiceGoサービスは、可能な限り標準のHTTPとRESTに近づけるよう努めています。

ステータスコード 説明
200 OK HTTPリクエスト成功の標準応答。実際の応答はリクエストメソッドによって異なります。GETリクエストでは、応答にはリクエストに対応するリソースエンティティが含まれます。POSTリクエストでは、応答にはエンティティの説明または実行されたアクションの結果が含まれます。
201 Created リクエストが完了し、新しいリソースが作成されました。
204 No Content サーバーはリクエストを正常に処理しましたが、コンテンツを返しませんでした。
400 Bad Request クライアント側のエラー（例：不正なリクエスト構文、無効なリクエストメッセージフレーミング、不正なリクエストルーティング）のため、サーバーはリクエストを処理できませんでした、または処理を拒否しました。
401 Unauthorized 認証されていません。
404 Not Found リクエストされたリソースが見つかりませんが、将来再び利用可能になる可能性があります。クライアントによる後続のリクエストは許可されます。
500 Internal Server Error サーバー内部エラー。

呼び出しアドレス

フォーマット

https://servicego.udesk.cn/api/v1/[インターフェース相対アドレス]?[URLパラメータ]&email=[管理者メールアドレス]&timestamp=[タイムスタンプ]&sign=[署名]

括弧で囲まれた部分の意味は以下の通りです：

変数 説明
インターフェース相対アドレス APIの相対URL。各APIで個別に明記されます。
URLパラメータ リクエストアドレス内のパラメータ。複数ある場合は&で区切ります。
管理者メールアドレス ご利用のスーパー管理者のメールアドレス
タイムスタンプ リクエストを開始した時点のタイムスタンプ。'1970-01-01 00:00:00'から現在までの秒数。特に指定がない限り、デフォルトの有効期限は5分です。
署名 認証署名。特に指定がない限り、各APIリクエストにこのパラメータを付加する必要があります。詳細な生成アルゴリズムについては、認証方法をご覧ください。

パラメータ

3種類のパラメータタイプがあります：

タイプ 説明
URLに埋め込まれる リクエストURLの一部として。例：/contacts/:id の :id
URL param インターフェースリクエスト時のパラメータ。例：/contacts?page=10 の page
Request Body リクエストボディ

戻り値

UTF-8エンコードされたJSON文字列

認証方法（2021年6月3日以前のテナントに適用）

計算式

sign=SHA1(email&api_token&timestamp)

各要素：

例

https://servicego.udesk.cn/api/v1/contacts

認証に必要なデータ：

名称 値
email admin@udesk.cn
api_token 221b368d7f5f597867f525971f28ff75
timestamp 1496631984

署名の計算：

sha1("email@udesk.cn&221b368d7f5f597867f525971f28ff75&1496631984") -> a32be53bb42314850715f8b9ab92542f5ed54c5e

リクエストURL：

https://servicego.udesk.cn/api/v1/contacts?email=admin@udesk.cn&timestamp=1496631984&sign=a32be53bb42314850715f8b9ab92542f5ed54c5e

新認証方法（2021年6月3日以降のテナントに適用）

計算式

sign=SHA256(email&api_token&timestamp)

各要素:

例

https://servicego.udesk.cn/api/v1/contacts

認証に必要なデータ:

名称 値
email admin@udesk.cn
api_token 221b368d7f5f597867f525971f28ff75
timestamp 1496631984

署名の計算:

sha256("email@udesk.cn&221b368d7f5f597867f525971f28ff75&1496631984") -> d0eb64920d4cee192427ea43acfdb00cdc56acb79a2012bb96a1c5d5fa1df36f

リクエストURL:

https://servicego.udesk.cn/api/v1/contacts?email=admin@udesk.cn&timestamp=1496631984&sign=d0eb64920d4cee192427ea43acfdb00cdc56acb79a2012bb96a1c5d5fa1df36f