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

Overview

本APIはBiz安否確認/一斉通報におけるマスタ情報管理、発信操作、状況確認を行うAPIです。
ご利用いただくためには「Biz安否確認/一斉通報」のご契約が必要となります。
また、安否APIに申し込みいただく必要があります。

Resource URL

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

1.Base Path(Global Load Balance)

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

本APIをご利用いただく際のアカウント作成・設定方法

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

ディベロッパーポータル（本サイト）にログインし、APIを利用するためのKey / Secret情報を取得する。
OAuth AccessTokenの取得・利用APIでアクセストークンを取得する。以後のAPI利用の際にはアクセストークンをヘッダにセットする。
```
Authorization: Bearer [YOUR_ACCESS_TOKEN]
```
IAM APIを使用して、APIに使用する子ユーザ、グループ、ロールを作成する。
1. 子ユーザの作成
  - 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を保存しておくこと。こちらはBiz安否確認/一斉通報APIをご利用いただく際のユーザ情報として利用します。
2. グループの作成
  - IAM IAM - グループの作成APIを参考にしてグループを作成する（グループ名は自由）。
  - 作成の応答bodyに記載されているuuidを保存しておくこと。
3. 権限の作成
  - IAM 権限の作成APIAPIを参考にして、権限に制限がない（*指定）の権限を作成する（権限名は自由）。
  - 作成の応答bodyに記載されているuuidを保存しておくこと。
IAM APIを利用して、権限とグループ、グループとユーザを紐づける。
1. 権限とグループの紐づけ
  - 先ほど作成した権限とグループのuuidを用いて、権限とグループの紐づけを参考に紐づけする。
2. グループとユーザの紐づけ
  - 先ほど作成したグループとユーザのuuidを用いて、グループとユーザの紐づけを参考に紐づけする。
Biz安否確認/一斉通報APIの利用方法
1. 子ユーザ作成を実施した際の応答に含まれるconsumerKey、consumerSecretを用いて、再度OAuth AccessTokenの取得・利用APIでアクセストークンを取得する。
2. Biz安否確認/一斉通報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サービス提供時間は安否本体のサービス提供時間に準じます。