Skip to main content

API v2

APIの呼び出し#

WebSocketAPI以外の全てのAPIは、認証情報(APIキー又は、OAuth2のアクセストークン)を指定する必要があります。 決済情報の取得や、アカウント情報、契約情報の更新等にはOAuth2のアクセストークンが必要です。

APIキーはコントロールパネルから、発行ができます。

各種APIにはそれぞれ権限(スコープ)が必要となります。 APIキー、及びOAuth2にそれぞれ紐づけられた権限が不足している場合、APIはエラーを返します。

APIキーの権限等の変更は最大5分間反映されません。

APIキーの指定の仕方#

URLにクエリパラメータとして渡します。

https://api.dmdata.jp/v2/telegram?key=APIキー

アクセストークンの指定の仕方#

リクエストヘッダーにAuthorizationを使用します。

Authorization: Bearer アクセストークン


URLパラメータ#

APIはリソースを明確に指定する方法として、URLにIDなどを指定してリソースを取得・更新・削除するものがあります。

#

リソースID: 2500
リファレンス上のURL: https://api.dmdata.jp/v2/apikey/:id

とした場合、下記のようにURLを作成します。

https://api.dmdata.jp/v2/apikey/2500


カーソルトークン#

このAPIでは、1回のレスポンスで返しきれない情報があり、その場合レスポンス内にnextTokenを含めます。このnextTokenを同じエンドポイントにクエリパラメータcursorTokenに指定すると、続きの情報がレスポンスされます。

また、Telegram List v2ではPuLLで取得する際の通信量、処理量削減のため、レスポンス内のnextPoolingを、次回のクエリパラメータcursorTokenに指定してください。

これらのnextTokennextPoolingには次のリソース参照情報が含まれていますが、API検索クエリパラメータなどの情報は含まれないため、他のAPI検索クエリパラメータを指定していた場合、cursorTokenを使用する際にも前回と同様にAPI検索クエリパラメータを指定してください。

#

電文リストの続きを取得したい場合 ※認証情報は省略

1回目 リクエスト
https://api.dmdata.jp/v2/telegram?type=VXSE53

レスポンス

{
"responseId": "66d23c0cede77d82",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "ok",
"items": [{},{},{}],
"nextToken": "AAAAAA0000",
"nextPooling": "....."
}

2回目 リクエスト
https://api.dmdata.jp/v2/telegram?type=VXSE53&cursorToken=AAAAAA0000

とする。


標準エラー#

APIは標準的なエラーを次の通り返答します。

{
"responseId": "66d23c0cede77d82",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "error",
"error": {
"message": "Authentication required.",
"code": 401
}
}
プロパティ名出現説明
errorいつもObject
エラー情報。
error.messageいつもString
エラーメッセージ
error.codeいつもInteger
HTTPステータスコード
ステータスコードエラーメッセージ説明
400The query parameters are required.必須なクエリパラメータのプロパティがない
400The post parameters are required.必須なポストパラメータ(from post)のプロパティがない
400Unexpected data of search query `cursorToken`.無効なcursorTokenが指定された
401Authentication required.認証情報が指定されていない、または無効な認証情報
403AInsufficient scope for ... .認証情報に紐づけされたスコープ外、権限がない
403Requests are not allowed.許可されていない場所(IP,Domain)でのAPI呼び出し

型表現#

このリファレンス上で登場する型表現は以下の通りとします。

  • String - 文字列
  • Integer - 整数
  • Float - 浮動小数点数
  • Boolean - 真偽値
  • Array<型> - 配列 <>内は配列に配置される方を表現する
  • Object - 連想配列
  • Null - Null
  • ISO8601Time - String型で時刻を表現するISO8601拡張形式とする。タイムゾーンは世界協定時か日本標準時を使用
  • String<型> - String型だが、内容は<>内に指定された型を使用

クエリパラメータ、URLパラメータ#

クエリパラメータ、URLパラメータはすべてString型ですが、値の表現としてどの型が有効か示すため、String型以外の方もこのリファレンス上では使用します。

リソース#

Contract#

Socket#

Telegram#

WebSocket#

Parameter#