はじめに
Pocket Alert API ドキュメントへようこそ。このドキュメントでは、API の機能を包括的にご紹介し、本システムをスムーズにご利用いただけるようサポートします。以下では、API リクエストを行う前に欠かせない手順である認証について、必要な情報をまとめています。
認証
当社の API は、さまざまなユースケースやお好みに対応するため、2 種類の認証方式をサポートしています。
1. JWT トークン認証
JWT(JSON Web Tokens)トークンは、当社の API 認証方式を通じて取得できます。
JWT トークン認証を始めるには、以降のセクションで説明している認証エンドポイントにリクエストを送信してください。詳しくはドキュメントをご覧ください。
2. 事前作成トークン
また、認証には事前に作成したトークンをご利用いただくこともできます。これらのトークンはアカウントの API キーセクションから作成・管理できます。この方法であれば、追加の認証手順を経ることなく、簡単に API へアクセスできます。
次のセクションでは、エンドポイントの説明、リクエスト/レスポンスの例、ステータスコード、エラーメッセージなど、API の詳細を順にご紹介します。Pocket Alert とのスムーズな連携は、ここから始まります。
重要な注意事項
API にリクエストを送信する際は、必要なヘッダーを必ず含めてください。
いずれの認証方式もご利用いただけますが、トークンの使用を推奨します。トークンを使えば、サービスやアプリケーションごとにデータへのアクセスを分けて管理できます。