Authy API

Twilioのアカウントセキュリティー製品の一環として、Twilio Authy APIはWebアプリケーションへの二要素認証やパスワードレスのログインの追加を簡単にします。 音声通話およびSMS経由でのOTP(ワンタイムパスワード)、無料のAuthy AppまたはSDKで生成されるTOTP(時間ベースのワンタイムパスワード)、そしてこちらも無料のAuthy AppまたはSDKを使用したプッシュ認証をサポートします。 APIを使い始めるには、まずConsole上でアプリケーションを作成し、APIキーを入手してください。

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 -g “https://api.authy.com/protected/json/reporting/events?\
query[time][gte]=2017-04-01T00:00:00.000Z\
&query[time][lt]=2017-05-01T00:00:00.000Z\
&query[event][gte]=phone_verification_\
&query[event][lt]=phone_verification_z” \
-H “X-Authy-API-Key: $AUTHY_API_KEY”

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

アカウントセキュリティー APIキー

Authy APIリファレンス

APIリファレンスをすぐにご覧になりたいですか? これらのページは認証の実装の際に手順を追う必要のあるおおまかな順序で並んでいます。

エラーのトラブルシューティングやレスポンスについて理解したいですか?

サポートされる形式

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

cURL APIサンプル

APIを通じて実行できるさまざまなアクション用のcURLコマンドを含むリポジトリーを用意しています。 また、Postman向けのコレクションおよび環境のサンプルも含まれています。

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

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

Authenticator SDK

Authy Appを使用すればもっとも手早く使用を始められますが、SDKをサポートしたご自身のモバイル認証アプリケーションを開発することもできます。

ヘルプが必要ですか?

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