Biz安否確認/一斉通報 API

Overview

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

Resource URL

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

1.Base Path(Global Load Balance)

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

2.Base Path(Region)

https://{region}.api.ntt.com/v1/anpi
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/anpi
  • 指定できるregionは、将来拡充予定

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サービス提供時間は安否本体のサービス提供時間に準じます。