メインコンテンツまでスキップ

@pocket REST APIリクエスト送信

atPocket.api を利用することで、@pocket のWebAPIを簡単に呼び出し、アプリケーションデータを操作できます。
リクエストの送信方法として、HTTPメソッド（GET, POST, PUT, DELETE など）を指定できます。

構文​

atPocket.api(url, method, params, successCallback, errorCallback);

引数​

引数名型説明
urlstringリクエスト先のURL or WebAPIエンドポイント（必須）
@pocket REST APIのエンドポイントを指定した場合、適切なURLを自動生成します。
methodstringHTTPメソッド（必須）
使用可能なメソッド: GET, POST, PUT, DELETE など。
paramsobjectリクエストのパラメータ
GET メソッドの場合はクエリパラメータ、その他はリクエストボディとして送信。
空オブジェクト を渡すことでパラメータなしでリクエストできます。
successCallbackfunctionリクエスト成功時のコールバック関数
引数にはサーバーからのレスポンスデータが渡されます。
errorCallbackfunctionリクエスト失敗時のコールバック関数
引数にはエラー情報が渡されます。

使用例​

@pocket WebAPIのエンドポイントを指定する場合​
  • /api以降のURLを指定します。
// 一覧取得: GET: /api/apps/1/records の場合
atPocket.api('/apps/1/records', 'GET', {}, (result) => {
    if (result) {
        // 取得したレコード一覧を使用した処理
    }
});