共通仕様

共通仕様


dodaiiはRESTベースのAndroid向けAPIを提供しています。POSTリクエストを利用し、dodaiiに登録されている情報を閲覧したり、dodaiiにトランザクション情報を保存したりすることが可能です。APIのレスポンスはjsonで返却されます。文字コードは入出力ともにUTF-8です。

共通リクエストパラメータ 

●アプリケーションID 

 全てのAPIにはアプリケーショントークンが必要です。トークンはdodaiiパネルのApplicationListのページで確認出来ます。




●DeviceID(端末固有ID)

購入確認以外のAPIでは、DeviceIDを送信することを推奨しています。これは、処理上は利用しませんが、通信ログとしてdodaii上に記録し、トラブルの際などの手がかりとなることを想定しています。購入確認APIでは必須パラメーターとなっています。

APIバージョン

正式リリース後は、APIの仕様変更は原則行わず、バージョン番号による新旧使用の平行稼働を行います。旧バージョンの停止は1年以上前を目処にdodaii上にメールで告知します。
バージョン番号はAPIのURLで確認可能です。

https://dodaii.com/api/android/v<バージョン番号>/<メソッド名>

言語設定

プロダクトグループ、プロダクトには18種類の言語ごとに別の設定を行うことができます。
dodaii panelから設定した言語ごとの設定は、プロダクトAPIのlocalizationに記載され、localeパラメータにどの言語かの情報が記載されています。
言語とlocaleは以下の表をご確認ください。

 言語locale 
 Australian Englishen_AU
 Canadian Englishen_CA 
 Canadian French fr_CA
 Dutch nl
 English en
 French fr
 German de
 Italian it
 Japanese ja
 Mexican Spanish es_MX
 Spanish es
 UK English en_GB
 Simplified Chinese zh_Hans
 Brazilian Portuguese pt_BR
 Korean kr
 Portuguese pt
 Russian ru
 Swedish se

共通エラー

エラー時はHTTPステータスコード400または500を返却します。通常は200ですので、エラーハンドリングにご利用下さい。レスポンスにはエラーである旨とエラーIDをjsonで返却しますので、ログの収集、デバッグにご利用下さい。

 エラーケースエラーID
 必要なパラメータがない 1001
 パラメータの形式が異常・又は未登録の値 1002
 データが1件もない 1501
 データの有効期限切れ 1502
 シグネチャの検証に失敗 2001
 システム例外 5001またはなし


サンプルレスポンス(エラー) 

{"error":{"code":"1002","message":"undefined key.","requestedURI":"/api/android/v1/product/download/"}}