メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: API キー

APIキーはTwilioAPIにアクセスするためのクレデンシャルを表します。2つの理由があります。

APIキーはREST APIもしくはアカウントコンソールを通じて提供・破棄されます。TwilioAPIへのアクセス管理に非常にパワフルでフレキシブルな原理を提供します。例えば、APIキーを異なった開発者に、アプリケーション毎の異なったサブシステムそれぞれに発行することができます。APIキーは個別に破棄できます、APIクレデンシャルのライフサイクルを完全に管理できます。

メモ: /Accounts または /Key エンドポイントにアクセスすることが必要なユースケースの場合は、Consoleから作成可能なマスターキーを使用する必要があります。

APIキーを使用してREST APIの認証を行うサンプルを、以下に示します。

Loading Code Sample...
      
      
          
          
          
          
        

      APIキーインスタンスリソース

      リソースURI

      https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Keys/{API KeySid}

      リソースのプロパティ

      APIキーは下記のプロパティーで表されます。

      date_created
      date_time<rfc2822> Not PII

      このAPIキーの作成された日時で、RFC 2822タイムスタンプで表されます。

      date_updated
      date_time<rfc2822> Not PII

      このAPIキーがもっとも最近更新された日時で、RFC 2822タイムスタンプで表されます。

      friendly_name
      文字列 PII MTL: 30 DAYS

      このリソースを説明する文字列です。アプリケーションで選択されています。64 文字まで設定できます。

      sid
      sid<SK> Not PII

      このAPIキーを識別する 34 文字の文字列です。APIをを認証する際、ベーシック認証としてuserを利用します。

      HTTP GET

      上述のプロパティを含む、APIキーの表現を返します。

      注 : セキュリティ上の理由からこのSecretフィールドはAPIキーが最初に生成された時「のみ」表示されます。

      APIキーの例注 : API キーのSecretフィールドが編集済みの場合、SecretフィールドはAPIキーが最初に作成された時「のみ」表示されます。

      Loading Code Sample...
          
          
              
              
              
              
            

          HTTP POST

          APIキーのフィールドのアップデートが試行され、成功するとアップデートされたリソース表現を返します。成功すると、レスポンスはHTTP GETと同じものになります。

          オプションパラメーター

          下記の1つ以上のパラメータをAPIキーアップデートの際含める必要があります。

          FriendlyName
          オプション
          post 文字列 Not PII

          このリソースを説明する文字列です。アプリケーションで選択されています。64 文字まで設定できます。

          HTTP PUT

          サポートされていません。

          HTTP DELETE

          APIキーを削除するこれはREST APIへの認証を破棄し、同一のシークレットを使って作られた全てのアクセストークンが無効化されます。

          削除に成功すると、本文(Body)のない HTTP 204 レスポンスを返します。

          アカウントのアカウントSIDおよび認証トークン、またはConsoleで設定されたマスターキーフラグを持ったAPIキーで認証されたキーのみ削除可能である点に注意してください。

          APIキーリストリソース

          リソースURI

          https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Keys

          HTTP GET

          このアカウントのAPIキーのリストを返します。DateUpdated で並び替えられます。このリストはページ情報を含みます。

          全てのAPIキーが含まれます。

          アカウントに含まれる全てのAPIキーを検索します。

          Loading Code Sample...
              
              
                  
                  
                  
                  
                

              HTTP POST

              新しいAPIキーを作成します。

              アカウントのアカウントSIDおよび認証トークン、またはConsoleで設定されたマスターキーフラグを持ったAPIキーで認証されたキーのみ削除可能である点に注意してください。

              オプションパラメーター

              リクエストには、次のパラメーターを含めることができます。

              パラメーター 概要
              FriendlyName このリソースを説明する文字列です。アプリケーションで選択されています。64 文字まで設定できます。

              リクエストが成功すると、Twilio は新しいAPIキーを返します。この表現はAPIキーインスタンスリソースを使ってGETした場合と同様です。ただしSecretが含まれる場合は異なります。

              注 : セキュリティ上の理由から APIキーのシークレットはAPIキーが最初に生成された時「のみ」表示されます。アプリケーションは APIキーのSIDとシークレットをアクセストークンを将来作成するときのため、安全な場所に保管するべきです。

              フレンドリー名 "User Jenny" という APIキーを 生成する

              Loading Code Sample...
                  
                  
                      
                      
                      
                      
                    

                  HTTP PUT

                  サポートされていません。

                  HTTP DELETE

                  サポートされていません。

                  ヘルプが必要ですか?

                  We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                  Loading Code Sample...