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.
Since API Keys can be independently revoked, you have complete control of the lifecycle of your API credentials.
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 Node.js format | |
|---|---|
sid
|
このAPIキーを識別する 34 文字の文字列です。APIをを認証する際、ベーシック認証として |
friendlyName
|
このリソースを説明する文字列です。アプリケーションで選択されています。64 文字まで設定できます。 |
dateCreated
|
このAPIキーの作成された日時で、RFC 2822タイムスタンプで表されます。 |
dateUpdated
|
このAPIキーがもっとも最近更新された日時で、RFC 2822タイムスタンプで表されます。 |
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が含まれる場合は異なります。
注 : セキュリティ上の理由から 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.
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.
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 Node.js format | |
|---|---|
friendlyName
オプション
|
このリソースを説明する文字列です。アプリケーションで選択されています。64 文字まで設定できます。 |
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.
ヘルプが必要ですか？
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.