ナレッジ
知識・原因・設定・過去のノウハウを探す場所です。やりたいこと・症状・ツール名で探せます。
ツール: API 4件
絞り込みを解除- Webhookの基本(APIとの違い・受信URL・署名確認・再送・重複・失敗時) APIは自分から聞きに行く、Webhookは相手からイベント発生時に自サイトの受信URLへ知らせてくる。受信側は署名を確認して本物か確かめ、すぐ2xxを返し、同じ通知が再送・重複して届く前提で処理する。失敗はログに残す。
- APIエラーの見方(200系・400・401・403・404・422・429・500系でどこを疑うか) 400系は「送った側」、500系は「相手側」の問題が基本。401は認証(キー・トークンの誤り・期限切れ)、403は権限・プラン・IP制限、404はURLや対象ID、429は回数制限、500系は相手の障害。まずエラー本文(JSON)を読む。
- CORSエラーの基本(別オリジン・ブラウザの制限・Access-Control-Allow-Origin・iframeとは別問題) ブラウザのJavaScriptから別オリジン(ドメイン・プロトコル・ポートが違う)のAPIを呼ぶと、相手のサーバーがAccess-Control-Allow-Originで許可していない限りブラウザが結果を読ませない。直すのは基本的にAPI側の設定か、自分のサーバー経由で呼ぶこと。ブラウザ側のコードだけで必ず解決できるものではない。iframeの表示可否は別問題。
- APIの実務の基本(GET/POST/PUT/PATCH/DELETE・JSON・ヘッダー・認証/トークン・レート制限・ページング・タイムアウト・リトライ) APIは「URL+方法(GET/POST等)+ヘッダー(認証・形式)+本文(JSON)」で頼み、ステータスコードとJSONで答えが返る。認証キーはサーバー側だけに置きブラウザのJSに書かない。レート制限・ページング・タイムアウト・リトライを前提に作る。