外部APIリクエスト送信
外部APIを呼び出す際、リクエストの ヘッダやボディ に {パラメータ名} を指定すると、@pocket の 設定画面 で定義した proxy.(パラメータ名) の値に自動的に置き換えられます。
この仕組みにより、クライアント側には秘匿情報(APIキーや認証情報など)を渡さず、@pocket が 内部で秘匿情報を適用した状態で実行 するため、安全に外部APIを呼び出すことが可能です。
また、クロスドメイン制約を回避して、外部APIにリクエストを送信できます。
カスタマイズ開発での使用について
このメソッドはカスタマイズ開発でも使用できますが、カスタマイズ開発で使用の場合、proxy.(パラメータ名)の指定ができないため、情報を秘匿できません。
API Key等をプログラム上に記述するのは非常に危険なため、プログラムに直接記述しないようにしてください。
構文
atPocket.proxy(url, headers, data, successCallback, failureCallback);
引数
| 引数名 | 型 | 説明 |
|---|---|---|
url | string | 呼び出す外部APIのエンドポイントURL |
method | string | GET | POST | PUT | DELETE |
headers | object | リクエストヘッダ({パラメータ名} を指定可能) |
data | object | リクエストボディ({パラメータ名} を指定可能) |
successCallback | function | リクエスト成功時に実行されるコールバック関数 |
failureCallback | function | リクエスト失敗時に実行されるコールバック関数 |
使用例
atPocket.proxy(
"https://api.example.com/data",
"GET",
{ Authorization: "{apiKey}" },
{ query: "test" },
function(response) {
console.log("Success:", response);
},
function(error) {
console.log("Error:", error);
}
);
この例では、ヘッダーの {apiKey} の値が、@pocket の設定画面で定義された proxy.apiKey に置き換えられてリクエストが送信されます。