Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
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 キー

You access the Twilio API using API keys that represent the required credentials. These keys:

  • Authenticate to the REST API
  • Create and revoke Access Tokens

See this document for more information about your request to Twilio's REST API, or read our article on Access Tokens to learn more.

API Keys can be provisioned and revoked through the REST API or the Twilio Console. This provides a powerful and flexible primitive for managing access to the Twilio API.

For example, you might issue separate API Keys to different developers or to different subsystems within your application.

APIキーは個別に破棄できます、APIクレデンシャルのライフサイクルを完全に管理できます。

If your use case requires API Keys to access the /Accounts or /Keys endpoint, a Master Key needs to be used. This can be created in the Console.

Names in PHP format
sid
sid<SK> Not PII

The unique string that that we created to identify the Key resource.

friendlyName
文字列 PII MTL: 30 DAYS

The string that you assigned to describe the resource.

dateCreated
date_time<rfc2822> Not PII

The date and time in GMT that the resource was created specified in RFC 2822 format.

dateUpdated
date_time<rfc2822> Not PII

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

Create a new API Key

If a new API Key was created successfully, Twilio will respond with a representation of the new API Key.

This representation will be the same as that returned when fetching an API Key's instance resource, but will also include the Secret field.

POST

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

You may only delete Keys by authenticating with the account's AccountSid and AuthToken or API Keys that have the master key flag set in the console.

パラメーター

パラメーター 概要
FriendlyName A descriptive string that you create to describe the new key. It can be up to 64 characters long.

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

        
        
        
        
        Create a default API Key

        Create a new API Key

        Create a default API Key
              
              
              
              
              Create an API Key with the FriendlyName, in this case "User Joey".

              Create a new named API Key

              Create an API Key with the FriendlyName, in this case "User Joey".

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

              Fetch a Key resource

              GET

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

              Returns a representation of the API Key.

              For security reasons the Secret field is ONLY returned when the API Key is first created – never when fetching the resource.

              Names in PHP format
              accountSid
              必須
              GET sid<AC> Not PII

              The SID of the Account that created the Key resource to fetch.

              sid
              必須
              GET sid<SK> Not PII

              The Twilio-provided string that uniquely identifies the Key resource to fetch.

                    
                    
                    
                    
                    Note that the API Key's Secret field is redacted in the output of this example. As noted above, Secret fields are only returned when the API Key is first created.

                    Fetch an API Key

                    Note that the API Key's Secret field is redacted in the output of this example. As noted above, Secret fields are only returned when the API Key is first created.
                          
                          
                          
                          
                          An example fetching of an API Key.

                          Fetch an API Key

                          An example fetching of an API Key.

                          Read a Key resource

                          GET

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

                          Returns a list of API Keys in this account, sorted by DateUpdated.

                          The list includes all API Keys. It also includes paging information.

                          Names in PHP format
                          accountSid
                          必須
                          GET sid<AC> Not PII

                          The SID of the Account that created the Key resources to read.

                                
                                
                                
                                
                                Retrieve all the API Keys in an account

                                Read Keys

                                Retrieve all the API Keys in an account

                                Update a Key resource

                                POST

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

                                Attempts to update the fields of an API Key instance.

                                If successful, it returns the updated resource representation. The response will be identical to that of the HTTP GET (fetch).

                                Names in PHP format
                                accountSid
                                必須
                                post sid<AC> Not PII

                                The SID of the Account that created the Key resources to update.

                                sid
                                必須
                                post sid<SK> Not PII

                                The Twilio-provided string that uniquely identifies the Key resource to update.

                                friendlyName
                                オプション
                                post 文字列 PII MTL: 30 DAYS

                                A descriptive string that you create to describe the resource. It can be up to 64 characters long.

                                      
                                      
                                      
                                      

                                      Delete a Key resource

                                      削除

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

                                      Deletes an API Key. This revokes its authorization to authenticate to the REST API and invalidates all Access Tokens generated using its secret.

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

                                      You may only delete Keys by authenticating with the account's AccountSid and AuthToken or API Keys that have the master key flag set in the console.

                                      Names in PHP format
                                      accountSid
                                      必須
                                      削除する sid<AC> Not PII

                                      The SID of the Account that created the Key resources to delete.

                                      sid
                                      必須
                                      削除する sid<SK> Not PII

                                      The Twilio-provided string that uniquely identifies the Key resource to delete.

                                            
                                            
                                            
                                            

                                            Login with an API key

                                            Using a helper library for the language of your choice, you can use your API keys to authenticate and use the Twilio REST API.

                                                  
                                                  
                                                  
                                                  
                                                  Rate this page:

                                                  ヘルプが必要ですか?

                                                  誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。