シェア:
){kind=small}
AlvaroはVonageの開発者支持者であり、ネットワークAPIに焦点を当てています。デベロッパーエクスペリエンス、API、オープンソースに情熱を注ぐ。仕事以外では、コミックショップを探検したり、SFやホラーフェスティバルに参加したり、有名な小さなプラスチックブロックで何かを作ったりしているところをよく見かける。
ネットワーク・レジストリの紹介
所要時間：1 分
Network API は企業向けであり、個人、趣味、または独立した開発者向けではありません。従って、ネットワークAPIコールを行う前に、通信サービスプロバイダー（CSPs）の承認を得るために会社プロフィールを提出し、アクセスを得る必要があります。このプロセスを合理化するために、VonageはVonageサービスが利用可能なすべての国でサポートされているすべてのネットワークAPIについて、様々なCSPとの登録を裏で処理しています。
承認プロセスは2段階ある：
ビジネスプロフィールを作成する。
アプリケーション・プロファイルを作成する。
どちらの手順も、Vonage Network Registryを使用して、次のどちらかの方法で完了できます。 ダッシュボードまたは API.
このチュートリアルでは、すでにVonageアカウントをお持ちであることを前提としています。お持ちでない場合は、こちらから作成できます。 こちら.
ネットワークレジストリは、ユーザーのダッシュボードからアクセスできます。Vonageアカウントにログインし、ポータル右側のアバター画像の下にある "My dashboard "をクリックします。左のナビゲーションメニューを使用して、「構築と管理」セクションを探します。次に、レジストリ -> ネットワークレジストリをクリックします。
ビジネスプロフィールには、貴社の法的情報が含まれます。をクリックしてください。ビジネスプロフィールの追加"をクリックし、以下の情報を入力してください：
国 - エンドユーザーがアプリケーションにアクセスする国。
役割 - 組織におけるあなたの役割。
Business Name - Vonage Network APIを使用するアプリケーションを所有する法人名。
組織の種類 - ドロップダウンリストから最も適切な種類を選択します。
ビジネス登録住所/国 - あなたの組織が登録されている住所と国。
事業税番号 - VonageとそのCSPがお客様の組織を確認するために使用する税務参照番号です。
プライバシー・ポリシー URL-Vonage およびその CSP は、Network API を使用する者に対して、インターネット上で公開されているプライバシー・ポリシーを持つことを要求します。ポリシーの URL を指定してください。
プライバシーポリシー管理者のEメールアドレス - プライバシーポリシーに関する質問に使用できるEメールアドレスを記載します。
データ保護責任者（DPO）のEメールアドレス - これは法律で義務付けられている場合のみ。
New Business Profile
送信後、あなたのビジネスプロフィールの概要が表示されます。このサマリーは、あなたの登録状況を把握するのに役立ちます。登録状況が変更された場合は、Eメールでお知らせします。
承認要求に対する CSP の応答は非同期であり、Vonage Network Registry が異なる時間に受信する場合があります。
アプリケーション・プロファイルは、どのネットワークAPIが必要で、どのような目的で使用されるかを含む、特定のユースケースを記述するために使用される。これらは、関連するビジネス・プロファイルに含まれる国の CSP と共有される。
左のナビゲーションメニューから Network Registry エントリーに移動し、ビジネスプロファイル名をクリックし、"Add application profile" を選択します。フォームが表示され、構築するアプリケーションの種類に関する詳細情報を入力する必要があります：
プロファイル名 - アプリケーション・プロファイルを簡単に識別できるように名前を付けます。
Category - ドロップダウンリストからアプリケーションのカテゴリーを選択します。
インフラストラクチャーの場所 - 要求されたネットワークAPIの使用に関連する個人データを処理する可能性のある国の場所を指定します。
ネットワークAPI - 使用するネットワークAPIを選択します。
目的 - 選択した各ネットワークAPIについて、ドロップダウン・リストから目的を確認する。
ユースケースの説明：消費者の視点からアプリケーションを説明してください。
New Application Profile
申請後、申請プロフィールの要約が送信されます。出願状況に変更があった場合は、Eメールでお知らせします。
申請プロフィールの承認プロセスのステータスを監視できます。左のナビゲーション・メニューの「Network Registry」エントリーに移動し、ビジネス・プロファイルをクリックします。ビジネス・プロファイルの概要ページが表示されます。そこで、ページ下部のアプリケーション・プロファイル・エントリーの折りたたみを解除します。ビジネス・プロファイルの作成時に選択した国の CSP のリストと承認ステータスが表示されます。
Network APIs Submission Status
ネットワーク・レジストリAPI を使うと、開発者はビジネスとアプリケーションのプロファイルをプログラムで送信できる。これは、組織内の異なるチームが Network API を使用する場合に特に便利で、各チームが内部プロセスを通じて必要に応じて個別のアプリケーション・プロファイルを作成し、使用することができます。
Network Registry APIコールを完了するには、すべて認証が必要です。認証は、ダッシュボードの概要ページで確認できるAPIキーとシークレットに基づいて行われます。URL内に送信されます。
API Key Secret
警告あなたのAPI認証情報は秘密であり、個人的な使用のみです。誰とも共有しないでください。
この /business-profileエンドポイントは、ビジネス・プロファイルのすべての操作 (作成、取得、削除など) に使用されます。
新しいビジネス・プロファイルを作成するには POSTリクエストを送信する必要があります。呼び出しの本文には、ネットワークレジストリダッシュボードで要求されたものと同じ情報（役割、国、税番号など）が含まれます。
以下の例では、cURLを使用して「My business profile」という新しいビジネス・プロファイルを作成し、スペインとドイツのオペレーターへのアクセスを要求している：
curl -X POST "http://api-eu.vonage.com/v1/network-registry/business-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
"contact_role":"developer",
"name":"my business profile",
"organisation_type":"forProfitOrganisation",
"country":"ES",
"tax_number":"1234567890",
"privacy_policy_url":"https://1LThiQzd.com",
"privacy_policy_manager_email":"manager@test.com",
"dpo_email":"dpo@test.com",
"dpo_required":true,
"countries":[
"ES",
"DE"
],
"business_information":{
"address_street_1":"address 1",
"address_street_2":"address 2",
"city":"Madrid",
"province":"Madrid",
"postal_code":"28020",
"country":"ES"
},
"email_notifications_enabled":true,
"terms_and_conditions_accepted":true
}'
ビジネスプロファイルのリストを取得するためにGETリクエストを送り、そのステータスを監視することができる：
curl "http://api-eu.vonage.com/v1/network-registry/business-profiles" -u ${API_Key}:${API_Password}を送信することで、指定された CSP のビジネス・プロファイル情報を取得することも可能です。 GETリクエストを /business-profile/{id}/cspsエンドポイントに
curl "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123/csps" -u ${API_Key}:${API_Password}ビジネスプロファイルを変更したい場合、/change-requestにPUTリクエストを送ることができる。
curl -X PUT "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123/change-request" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
"countries": [
"ES"
],
"contact_role": "A Business Profile",
"name": "A Business Profile",
"trading_name": "A Business Profile Ltd.",
"organisation_type": "For-Profit Organisation",
"tax_number": "98284687G",
"privacy_policy_url": "https://www.businessinc.com/privacy_policy",
"privacy_policy_manager_email": "privacy.manager@business.com",
"dpo_email": "dpo@business.com",
"dpo_required": true,
"terms_and_conditions_accepted": true,
"business_information": {
"address_street_1": "Main Street 5",
"address_street_2": "Extra long address",
"postal_code": "W1 5DU",
"country": "UK",
"city": "London",
"province": "City of London"
},
"email_notifications_enabled": true
}'
最後に、このコマンドを実行することで、既存のビジネス・プロファイルを削除することができる：
curl -X DELETE "http://api-eu.vonage.com/v1/network-registry/business-profiles/0934561-99ce-123
ビジネス・プロファイルと同様に、アプリケーション・プロファイルに関連するすべての操作を実行するために /application-profilesエンドポイントを使用して、アプリケーション・プロファイルに関連するすべての操作を実行できます。
次の例は、新しいアプリケーション・プロファイルを作成するために POST リクエストを送信します：
curl -X POST "http://api-eu.vonage.com/v1/network-registry/application-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
"business_profile_id": "string",
"name": "Network Application Profile",
"description": "This is an example use case for Fraud Prevention",
"category_id": "finance",
"network_apis": [
{
"network_api_id": "sim-swap",
"purpose_ids": [
"FraudPreventionAndDetection"
]
}
],
"terms_and_conditions_accepted": true,
"infrastructure_locations": [
"ES"
}'
GET リクエストを送信することで、アプリケーションプロファイルのリストを取得することができます。のようなクエリパラメータを送信することで、結果をフィルタリングできます。 ステータス(保留、受理、拒否など)、または business_profile_idまた、特定のビジネスプロファイルからアプリケーションプロファイルを取得することもできます。
curl "http://api-eu.vonage.com/v1/network-registry/application-profiles" -u ${API_Key}:${API_Password}APIリファレンス APIリファレンスに、その他の操作の詳細な説明がある。
ビジネス・プロファイルやアプリケーション・プロファイルを管理するための操作だけでなく、Network Registry APIは、国、サポートされているネットワークAPI、組織タイプなど、他のリソースを操作するための便利なエンドポイントを提供する。
サポートされている国のリストを得るには、次の例のようにGETリクエストを送ればよい：
curl "http://api-eu.vonage.com/v1/network-registry/catalogue/countries" -u ${API_Key}:${API_Password}同様に、GET リクエストを/エンドポイントエンドポイントに GET リクエストを送ると、サポートされている Network API の一覧を取得できます：
curl "http://api-eu.vonage.com/v1/network-registry/catalogue/network-apis" -u ${API_Key}:${API_Password}その カタログセクションには、以下の方法でアクセスできるリソースのリストが含まれています。 /カタログエンドポイント経由でアクセスできるリソースのリストが含まれています。
少なくとも1つのCSPによってサブミッションが承認されると、それを1つまたは複数のVonageアプリケーションにリンクして、Network APIの使用を開始できます。VonageアプリケーションにはAPIコールに必要な認証情報が含まれています。
ご連絡をお待ちしております！参加する VonageコミュニティSlackチャンネルに参加して、ネットワークレジストリを使用した経験を共有してください。Vonage Developer Experience チームをフォローすることもできます。 X以前は Twitter として知られていました。