Biz安否確認／一斉通報 API | NTT DOCOMO BUSINESS DeveloperPortal

Overview

本APIはBiz安否確認/一斉通報におけるマスタ情報管理、発信操作、状況確認を行うAPIです。
また、Biz安否確認/一斉通報API（以下、安否API）を利用される旨を「Biz安否確認/一斉通報」にお申し込みいただく必要がありますので、担当営業にお申し出ください。（既契約の場合は、変更手数料を申し受けます。）
お申し込み受領後、設定完了までに５営業日程度お時間を頂戴します。

Resource URL

グローバル共通ドメインをご利用ください。グローバル共通ドメインを利用する場合、お客さまのご利用箇所の状況に応じて、一番近いAPIゲートウェイに接続します。

Base Path(Global Load Balance)

https://api.ntt.com/v1/anpi

本APIをご利用いただくための初期設定手順

2025年以降の新規API利用におきましては、ビジネスポータルよりAPI利用申請を行い付与されたアカウント（権限管理者ユーザ）では安否APIを利用することはできません。
以下の手順に従って子ユーザを作成いただき、その子ユーザの認証で得られた consumerKey / consumerSecret で安否APIをご利用ください。

１．APIを利用するための consumerKey / consumerSecret の取得

ビジネスポータルにAPI利用申請を行い、付与されたアカウントで NTT DOCOMO BUSINESS APIs | NTT DOCOMO BUSINESS DeveloperPortal にログインし、APIを利用するための consumerKey / consumerSecret 情報を取得します。
DeveloperPotalへのアカウントをお持ちでない場合は、アカウントの作成をお願いします。アカウント作成にご不明な点がある場合は、担当営業にご相談ください

２．権限管理者ユーザでのOAuth認証API認証およびアクセストークンの取得

OAuth AccessTokenの取得・利用API を参考に、clientId には consumerKey を、clientSecret には consumerSecret をセットし、アクセストークンを取得してください。
「３．IAM APIを用いた子ユーザのセットアップ」におけるAPIはこちらのアクセストークンをリクエストヘッダに以下のようにセットしてご利用ください。

Authorization: Bearer [YOUR_ACCESS_TOKEN]

３．IAM APIを用いた子ユーザのセットアップ

１）子ユーザの作成
IAM - ユーザの作成API を参考に子ユーザを作成します。

Content-Type: application/json; charset=utf-8

POST /v1/iam/users
[
    {
        "mail":"{APIを使用するお客さまの団体コード}@d-anpi.com",
        "portalUse":"0",
        "distributorFlag":"0"
    }
]

※応答bodyに記載されているuuidを保存してください。こちらはこの後の紐づけ処理に使用します。
※同じく応答bodyに記載されているconsumerKeyおよびconsumerSecretを保存してください。こちらは実際に安否APIをご利用いただく際の認証情報として利用します。紛失や第三者に利用されないよう厳重に保管してください。
※もし認証情報を紛失・失念してしまった場合は、セキュリティの問題があるためこの子ユーザは削除し、新たな子ユーザ作成からやり直してください。

２）グループの作成

IAM - グループの作成API を参考にしてグループを作成します（グループ名称に制限はありません）。
※作成の応答bodyに記載されているuuidを保存してください。

３）権限の作成

IAM - 権限の作成API を参考にして、権限を作成します（権限名称に制限はありません）。
セキュリティ担保のため、「ipAddress：利用許可するアクセス元グローバルIPアドレス」の設定を強く推奨します。
それ以外の項目は制限なし（*指定）で問題ありません。
※作成の応答bodyに記載されているuuidを保存してください。

４）権限とグループの紐づけ

先ほど作成した権限とグループのuuidを用いて、IAM - ユーザグループと権限の紐付けを参考に紐づけします。

５）グループとユーザの紐づけ

先ほど作成したグループとユーザのuuidを用いて、IAM - ユーザグループとユーザの紐付けを参考に紐づけします。

４．安否APIを利用する

これで安否APIを利用する準備が整いました。
以下の手順で子ユーザのアクセストークンを取得しリクエストヘッダにセットすることで安否APIがご利用いただけます。

子ユーザのOAuth認証

子ユーザ作成を実施した際の応答で得られたconsumerKey／consumerSecretをそれぞれclientId／clientSecretにセットし、OAuth AccessTokenの取得・利用API で子ユーザのアクセストークンを取得します。安否APIは、こちらのアクセストークンをリクエストヘッダに以下のようにセットしてご利用ください。

Authorization: Bearer [YOUR_ACCESS_TOKEN]

Resource Information

key	value
レスポンスフォーマット	JSON
認証(OAuth)	Yes

基本情報

項目	説明
APIの仕様	REST API（REpresentaitional State Transfer API）に準じます。
プロトコル	RFC 7230～7235 で定義されるHTTP/1.1 規程に準じます。
HTTP メソッド	GET/POST/PUT/DELETE の4 つのHTTP Methodを用います。それぞれリソース操作(CRUD: READ/CREATE/UPDATE/DELETE)に対応しています。
Content-Type	API Bodyの入出力値についてはJSON形式とし、RFC 4627 に従います。

データフォーマット

項目	説明
文字コード	UTF-8のみ対応しています。
エスケープ文字	\(Back Slash)を使用します。
日付フォーマット	RFC3339（タイムゾーンは日本）に従います。
バージョン	v と整数のバージョンがURI のトップレベルに付きます。

API一覧

API ID	API名	処理方式	Path	HTTPメソッド
PE01	個人情報 API	同期	v1/anpi/maintenance/user/	GET,POST,PUT,DELETE
PE04	組織情報 API	同期	v1/anpi/maintenance/organization/	GET,POST,PUT,DELETE
PE05	グループ情報 API	同期	v1/anpi/maintenance/group/	GET,POST,PUT,DELETE
PE06	ロケーション情報 API	同期	v1/anpi/maintenance/location/	GET,POST,PUT,DELETE
PE07	ユーザ設定コード情報 API	同期	v1/anpi/maintenance/user-setting-code/	GET,POST,PUT,DELETE
PE11	安否確認 API（集計一覧）	同期	v1/anpi/confirm/safety/	POST
PE12	安否確認 API（状況確認）	同期	v1/anpi/confirm/safety-status/	POST
PE13	安否確認 API（発信）	非同期	v1/anpi/request/safety/	PUT
PE14	安否確認 API（登録・完了）	登録は同期、完了は非同期	v1/anpi/register/safety/	POST,PUT
PE21	一斉通報 API（集計一覧）	同期	v1/anpi/confirm/broadcast/	POST
PE22	一斉通報 API（状況確認）	同期	v1/anpi/confirm/broadcast-status/	POST
PE23	一斉通報 API（発信）	非同期	v1/anpi/request/broadcast/	PUT
PE24	一斉通報 API（登録）	同期	v1/anpi/register/broadcast/	POST

※非同期処理は、実行後に状況確認APIを用いて実行結果をご確認ください。

レスポンスコード（HTTPステータスコード）

結果	HTTPステータスコード	備考
正常	200	OK（処理成功時）
正常	202	OK（非同期リクエスト成功時）
異常	400	エラー時：バリデーションエラー、指定ステータス以外（GETしか無いAPIに対してPOSTアクセス等）
異常	404	URL不正
異常	500	エラー時（想定外のエラー時）
異常	503	エラー時（メンテナンス時）

セキュリティ

以下のセキュリティ対策を講じています。条件に該当するリクエストはエラー応答となることがあります。
- Oauth API 認証
- DDoS 攻撃防御
- 大量アクセス対策

その他

安否API提供時間は、Biz安否確認/一斉通報のサービス提供時間に準じます。工事等の案内は、Biz安否確認/一斉通報の工事・故障情報一覧 | NTTドコモビジネスお客さまサポートをご確認ください。
また、API-GWの工事時もご利用いただけない場合があります。
NTTドコモビジネス　APIゲートウェイの工事・故障情報一覧 | NTTドコモビジネスお客さまサポート