概要

一般原則

HTTP リクエストメソッド

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

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

ページネーション

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

パラメータ タイプ オプション 説明
paging Object true ページネーションオブジェクト
paging.pageNum Integer true ページ番号
paging.pageSize Integer true ページサイズ
paging.total Long true 総数

HTTP ステータスコード

CASEサービスは、可能な限り標準的な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://km.udesk.cn/api/v1/{relative address}?{URL params}&email={administrator email}&timestamp={timestamp}&sign={signature}

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

変数 説明
relative address: インターフェース相対アドレス APIの相対URL
URL params: URLパラメータ リクエストインターフェースに必要なパラメータ
administrator email: 管理者メールアドレス スーパー管理者のメールアドレス
timestamp: タイムスタンプ リクエストを開始した時点のタイムスタンプ。'1970-01-01 00:00:00'からの秒数。特に指定がない限り、デフォルトの有効期限は5分です。
signature: 署名 認証署名。特に指定がない限り、すべてのAPIリクエストにこのパラメータを付加する必要があります。詳細な生成アルゴリズムについては、鉴权方法 を参照してください。

パラメータ 3種類のパラメータタイプ：

タイプ 説明
Path parameters リクエストURLパスの一部として使用されます。例：/leads/:id の :id
Query parameters インターフェースリクエスト時のパラメータ。例：/leads?page=10 の page
Request fields リクエストボディ（Request Body）

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

認証方法

公式

sign=SHA1(email&api_token&timestamp)

ここで:

例

https://km.udesk.cn/api/v1/leads

認証に必要なデータ:

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

署名の計算:

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

リクエストURL:

https://km.udesk.cn/api/v1/leads?email=email@udesk.cn&timestamp=1496631984&sign=a32be53bb42314850715f8b9ab92542f5ed54c5e