NTT Comサービス OAuth API

Overview

本APIは、APIゲートウェイで提供されるNTT Com各種サービスのOAuth API(OAuth2.0)です。

OAuth

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

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

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/oauth/accesstokens

2.Base Path(Region)

https://{region}.api.ntt.com/v1/oauth/accesstokens

region is jp|us|fr|sg
e.g. https://us.api.ntt.com/v1/oauth/accesstokens
指定できるregionは、将来拡充予定

Resource Information

Key	Value
レスポンスフォーマット	JSON
認証(OAuth)	Yes
帯域制御#1	Yes

#1 お客さま接続単位で適切な流量制限を実施

OAuth AccessTokenの取得

POST /v1/oauth/accesstokens

Request Parameters

Name	Description	type	mandatory
grantType	client_credentialsを指定	JSON	Yes
clientId	開発者ポータルで払いだされる対象AppのCousumer Keyを指定	JSON	Yes
clientSecret	開発者ポータルで払いだされる対象AppのConsumer Secretを指定	JSON	Yes

注意: JSONリクエストであるため、リクエストヘッダにContent-Type: application/jsonを指定すること。

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

POST /v1/oauth/accesstokens
{
   "grantType":"client_credentials",
   "clientId":"*************",
   "clientSecret":"*************"
}

Response Parmeters

Name	Description	type	mandatory
accessToken	アクセストークン	String	Yes
tokenType	トークンタイプ	String	Yes
expiresIn	トークン有効時間	String	Yes
scope	アクセストークンスコープ	String	Yes
issuedAt	トークン発行日時	String	Yes

Example Result

 {
   "accessToken": "[YOUR_ACCESS_TOKEN]",
   "tokenType": "BearerToken",
   "expiresIn": "3599" ,
   "scope": "READ WRITE" ,
   "issuedAt": "1407483969339"
 }

注意:API利用者は、取得したアクセストークンはAPIゲートウェイ利用規約に従い、センシティブに扱うこと。共有、および、他人に貸与してはなりません。

AccessTokenの利用

NTT Com APIでの利用は、OAuth仕様に基づきAuthorizationリクエストヘッダフィールドにaccessTokenを設定し、APIリクエストしてください。

 Authorization: Bearer [YOUR_ACCESS_TOKEN]

検索フォーム

現在地