Vonage APIを使用する

Vonage APIプラットフォームへようこそ！Vonageは、お好みのチャネルを使用して顧客と通信できるAPIスイートを提供しています。

このサイトでは、すべてのAPIに関する包括的なドキュメントを提供しています。特定のAPIを使用する際に必要な情報は、対応するセクションで見つけることができます。

しかし、理解しておくべき基本的な概念や、私たちのすべてのAPIに適用される便利なツールがあります：

アカウント登録

当社のAPIを使用するには、次のものが必要です。アカウント登録.これでAPIキーとシークレットが発行され、APIにアクセスできるようになります。

開発者ダッシュボードへのアクセス

アカウントを取得したら、次のページにログインできます。開発者ダッシュボード.開発者ダッシュボードは、GUIベースでアカウントを管理することができます：

APIキーとシークレットを見る.APIへのリクエストを認証するために、これらが必要です。
口座残高の管理.APIへのアクセスはリクエストごとに課金されます。最初のアカウント開設時に、いくつかの無料クレジットを差し上げます。トップアップ少なくなったら
バーチャル・ナンバーのレンタル.を使用することができます。バーチャルナンバー Vonageが提供する通話やメッセージの送受信サービスです。参照バーチャル番号を借りる.
アプリケーションの管理.APIの一部（VoiceやMessagesなど）では、APIを作成するためにアプリケーションこれは、セキュリティと構成情報のコンテナとして機能します。これらのアプリケーションは、Developer Dashboard で作成および管理できます。
アカウントの管理.を実行することができます。その他の管理業務ここにある。

Vonage CLIの使用

オプションとして、Vonage CLI を使用してコマンドラインから Dashboard タスクの多くを実行することができます。これは多くの場合より速く、またこれらの操作をスクリプト化することができます。

Vonage CLI は oclif を使用してインストールすることができます。npm).その README での Vonage CLI GitHub リポジトリは、Vonage CLI のインストールと操作方法を説明します。

認証

Vonage APIを使用する場合、リクエストは以下のようにする必要があります。認証済み.通常、これは基本認証または JWT.Vonage CLI、または弊社のオンラインツール.一方基本認証ウェブフックを受信することはできません。 JWT.

Verify付きサイレント認証を使用する場合、ワークフロー配列の最初のチャネルでなければならない。

APIを使った実験

最終的に、あなたはアプリをあなたの選択したプログラミング言語.しかし手始めに、私たちのAPIにいくつかのサンプルリクエストを行い、正しいパラメータを提供し、希望するレスポンスが返ってきていることを確認するとよいでしょう。

コマンドラインツールカール各APIのCurlスニペットをコピー、貼り付け、変更することができます。

ポストマン

Curlよりも使いやすい様々なGUIツールが存在する。人気のあるものはポストマン.私たちのガイドを読む Postmanを使ってAPIを操作する.Vonageはまた、以下のセットも提供しています。ポストマンコレクションこれは、APIをすぐに使い始める方法を提供するものである。

オープンAPI

それぞれのAPIは OpenAPI仕様.OpenAPIについて詳しくは、以下の記事をご覧ください。ドキュメンテーション.私たちの仕様はOpenAPI仕様バージョン3（別名OAS3）に準拠しています。

サーバーSDKの使用

アプリを作り始める準備ができたら、各リクエストを手作業でコーディングする代わりに、当社のサーバーSDKのいずれかを使用することをお勧めします。すべてのSDKへのリンクはツールページを参照されたい。

Webhooksを使う

APIにリクエストして電話をかけたり、メッセージを送信したりする方法を学んだら、バーチャルナンバーでインバウンドコミュニケーションを受信する方法を学びたいと思うでしょう。

APIがあなたのアプリに何かを通知したいとき、それがIn-Appageのコールであれ、メッセージであれ、ステータス更新であれ、APIはあなたのアプリに、APIプラットフォームがリクエストできるURLエンドポイントを公開するよう要求します。これらは公共のインターネット上でアクセス可能でなければなりません。

これらのエンドポイントはWebhooksと呼ばれる。ウェブフックの詳細.ウェブフックを作成したら、それを使用するようにAPIプラットフォームに指示する必要があります。この手順は、使用するAPIによって異なり、完全な手順はそのAPIのドキュメントに記載されています。

開発中にこれらのウェブフックを一般公開するのは難しいので、以下のツールをお勧めします。ングロク.

のガイドをご覧ください。ングロクとのテスト使い方を学ぶ

Numbersフォーマット

Vonage API内では、すべての電話番号は E.164フォーマット.つまり、Numbers：

先頭の + といった国際アクセスコードを入力する。 00 または 001.
スペースなどの特殊文字を含まないこと、 () または -

例えば、米国の番号の場合、次のような形式になります。 14155550101.英国の番号は次のような形式です。 447700900123.

Numbersの書式がわからない場合は Number Insight API を使えば、Numbersに関する正しい情報を見つけることができる。

こちらも参照 Numbersフォーマットの Voice API ドキュメントを参照してください。

Concepts

JSONウェブトークン（JWT）、署名付きリクエスト、ウェブフックの使用など、Vonage API間で共有されているコンセプトがいくつかあります。以下のガイドでは、これらの要素の使用方法について詳しく説明しています。

Applications - Vonageエンドポイントに接続するために必要なセキュリティおよび設定情報。
認証 - APIキーとJSONウェブトークン（JWT）。
メッセージへの署名 - メッセージに暗号的に署名し、メッセージ署名をVerifyする方法。
ウェブフック - VonageのAPIは、Webhookを介してWebサーバにデータを送り返すことができます。
オープンAPI - すべてのVonage APIにはOpenAPIの記述があり、ご自身の開発プロセスで活用することができます。
用語集 - Vonageプラットフォーム全体で使用される一般的な用語の用語集。

次に何をすべきか

このガイドでは、APIを使用する際に知っておくべき基本的なコンセプトやツールを紹介しました。

これらの基本的なコンセプトを理解し、使用するツールをインストールしたら、ビルドを開始する準備が整いました！を見る選択したAPIのドキュメントを始める。

何か問題が発生した場合はコミュニティ・スラックまたは、ナレッジベースをご覧ください。サポートサイト.