IDCFクラウドのビリングAPI利用方法

はじめに

IDCFのビリングAPIの利用方法に関しては、下記参考URLに記載されております。
しかし、実際に下記の記事を参考にIDCFの利用明細を取得しようとした際、どういった値を入力すればよいのかがわからず、利用できるようになるまで時間がかかりました。
今回はビリングAPIを利用するにあたり、必要な値を記載していこうかと思います。

ビリングAPI利用方法

ビリングAPI使い方

ビリングAPIを利用するのに、追加でインストールするパッケージはございません。
curlコマンドによって利用明細を取得することができます。

▼例

$ curl -n https://your.idcfcloud.com/api/v1/billings/history \
  -G \
  -d format=json \
  -H "X-IDCF-APIKEY: SrE5Ceeb1Q9MPl0yM0qbd3D3_CCpLWqnbcruMBj2WyK03Q6r0l6YJhIdCsYUmB7VM8AFttoqsxc3FxQrsAh8VQ" \
  -H "X-IDCF-Expires: 1437142261" \
  -H "X-IDCF-Signature: EenNFoNxnYEQVGW279XcQ+tBgwFPpMmTkDZQvKryIZg="

ここでひとつ疑問に思うのは、どの値をどのように変更すればよいのかということです。
そこで変更する箇所について説明しようかと思います。

必要なHTTPヘッダ項目と入力例

1.history
2017-10
※[xxxx年]-[xx月]形式で取得したい利用明細の年月を指定

2.format
format=json
※利用明細の出力形式を「json」or「csv」で指定

3.X-IDCF-APIKEY
SrE5Ceeb1Q9MPl0yM0qbd3D3_CCpLWqnbcruMBj2WyK03Q6r0l6YJhIdCsYUmB7VM8AFttoqsxc3FxQrsAh8VQ
※管理画面上で確認できるIDCFアカウントの[ API Key ]を指定

4.X-IDCF-Expires
1437142261
※APIコマンドの有効期限をUNIX時間で定義

5.X-IDCF-Signature
EenNFoNxnYEQVGW279XcQ+tBgwFPpMmTkDZQvKryIZg=
下記手順で作成したシグネチャを指定

シグネチャ生成方法

必要な項目と入力例

1.HTTPリクエストメソッド
GET
※利用明細を取得するので「GET」を指定

2.リクエストAPIのパス
/api/v1/billings/history
※historyに[xxxx年]-[xx月]形式で年月を指定

3.APIキー
SrE5Ceeb1Q9MPl0yM0qbd3D3_CCpLWqnbcruMBj2WyK03Q6r0l6YJhIdCsYUmB7VM8AFttoqsxc3FxQrsAh8VQ
※管理画面上で確認できるIDCFアカウントの[ API Key ]を指定

4.有効期限
1437142261
※APIコマンドの有効期限をUNIX時間で定義

5.クエリストリング
format=json
※利用明細の出力形式を「json」or「csv」で指定

生成手順

1.上記5項目を改行(\n)で連結

GET\n/api/v1/billings/history\nSrE5Ceeb1Q9MPl0yM0qbd3D3_CCpLWqnbcruMBj2WyK03Q6r0l6YJhIdCsYUmB7VM8AFttoqsxc3FxQrsAh8VQ\n1437142261\nformat=json

2.当該アカウントのSecret Keyを秘密鍵として、上記2の文字列をHmacSHA256でエンコードし、それをBase64でエンコード実施。

参考URL

Billing API：http://docs.idcf.jp/cloud/billing/#s_fid=73BA0820D8B366EE-2F120BC0DAB7D752
APIリクエスト方法：http://docs.idcf.jp/cloud/billing/create_request.html