@pocket Web API リファレンス (1.0)

仕様

URL

ご契約サイトURL + 各APIでリクエストに必要なURL

Web APIの利用について

Web APIを利用して情報にアクセスするためには、認証キーが必要になります。

1. 認証キーは下記のメニューで作成できます。
   • アプリAPI：アプリ設定 > 設定 > 認証設定(サービス連携)
   • ユーザ/通知API：管理者設定 > 認証設定(サービス連携)
2. リクエストヘッダにX-At-Pocket-API-Keyを追加し、作成した認証キーをセットします。

リクエストヘッダ

レスポンス

HTTPステータスが200系の場合、正常終了になります。それ以外はエラーとなります。

エラーの場合はレスポンスボディに以下の内容を含むerrorsが含まれます。

{
    "errors": {
        "code": 400,
        "message": "Bad Request",
        "details": [
            {
                "message": "アプリIDは半角数字で入力してください。"
            }
        ]
    }
}

エラーメッセージ

リクエストでエラーが発生した場合、2つのエラー情報を返却します。

• HTTPステータスコード
• 応答本文内のJSONメッセージ

エラーメッセージはアプリ管理メニュー内の「サービス連携 > 監査ログ」からも確認できます。

エラー内容と対応方法

制限事項

@pocket Web APIの利用には以下の制限があります。制限は今後変更される可能性があります。

• リクエスト件数はAPI単位でカウントを行い、月単位でリセットされます。
  ※ 利用制限数は 月30,000件 までとなります。ただし、通知APIに限り 月100,000件 まで利用可能です。
• リクエストのカウントはサイト単位で行います。複数ユーザでリクエストを行った場合、各リクエストが1回としてカウントされます。
• 100秒当たりの利用制限数は100回までとなります。
• 一度に取得できる最大件数は1,000件までです。
• 一度に登録できる最大件数は1,000件までです。
• 存在しないフィールドをリクエストに含めた場合、その値は無視されます。

ファイルデータの扱い

ファイルデータの登録・更新は下記のような形式で行います。

{
    "field-1": [
      {
        "name": "Sample.png",
        "type": "image/png",
        "content": "..." 
      },
      {
        "name": "Sample2.png",
        ...
      }
    ]
}

フォームのAPI

フィールドのAPI

組織のAPI

役職のAPI

利用者のAPI