メニュー

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?

Authy API

As part of Twilio's account security offerings, the Twilio Authy API makes it simple to add a second factor of authentication or passwordless logins to your web application. It supports OTP sent via voice and SMS, TOTP generated in the free Authy app and push authentication via the free Authy app. To start working with the API, first create an application in the console and get the API Key.

APIのベースURL

リファレンスドキュメントの URL はすべて、次のベース URL を使用しています。

https://api.authy.com

Authy REST APIへの全リクエストは、HTTPS経由で提供されます。 暗号化されないHTTPはサポートされません。

AuthyのAPIキー

Authy REST APIの /protected エンドポイントへのすべてのHTTPリクエストは、HTTPヘッダー X-Authy-API-Key として渡すAPIシークレットによって保護されています。 例:

curl 'https://api.authy.com/protected/json/app/details' \
-H "X-Authy-API-Key: $AUTHY_API_KEY"

APIキーはTwilio ConsoleのAuthyセクションで、対象のAuthyアプリケーションをクリックすると見つかります。

Account Security APIキー

サポートされる形式

Authy APIは現在JSONおよびXML形式がサポートされています。 API呼び出しを行う際、json または xml 形式を指定することが必要です。

Authy Workflow

This guide shows the 3 steps to completing a basic two-factor verification via SMS. Follow the links for more documentation on advanced features such as sending Push Authentications, registering users without needing their phone number or email, PSD2 compliance, and more.

First, create an Authy Application in the Twilio Console and grab the API Key as demonstrated above.

        
        
        
        
        The AUTHY_ID from this step is necessary to send One-Time Passwords

        Step 1: Create an Authy User

        The AUTHY_ID from this step is necessary to send One-Time Passwords

        An Authy Application is the set of common configurations used to create and check one-time passcodes and manage push authentications. This includes features like:

        • Application Name (used in the one-time password message templates)
        • Token Length
        • ...and more

        One application can be used to send multiple tokens, it is not necessary to create a new application each time.

        Authy Users documentation.

              
              
              
              

              This will send a token to the end user through the specified channel. Supported channels are sms or call.

              If the user has the Authy App, by default, the API will not send the 2FA code via SMS or voice. Instead, a push notification will go to the device, prompting the user to start their app to get the code. You can override this behavior.

              One-time Password documentation.

                    
                    
                    
                    

                    This will check whether the user-provided token is correct. The first time you verify a user you will need to force verification to complete the user registration process.

                    token Success in response Message in response
                    Correct true Token is valid.
                    Incorrect false Token is invalid

                    One-time Password documentation.

                    Authyのヘルパーライブラリー

                    標準的なすべてのWebプログラミング言語用に、これらのAPI呼び出しを抽象化したヘルパーライブラリーもご利用いただけます。

                    Rate this page:

                    ヘルプが必要ですか?

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