Import API の利用方法
『奉行クラウド』の［汎用データ受入］機能に相当する処理を行う API で、Import API と ImportResult API が対になっています。
『奉行クラウド』のサーバー内で非同期で実行される登録処理を、Import API でリクエストし、ImportResult API で進捗状況と処理結果を取得する仕組みです。
詳細は、API ごとのリファレンスをご参照ください。
Import API
データの登録処理をリクエストする API です。
『奉行クラウド』のサーバー内に受け付けられると、一連の処理を特定する「operationID」が割り当てられ、レスポンスとして取得できます。
Response Body プロパティ一覧
ImportResult API
Import API のレスポンスで取得した「operationID」を使用して、進捗状況と処理結果を取得する API です。
処理の進捗状況は、レスポンスボディの「status」で取得できます。
Request Body プロパティ一覧
Response Body プロパティ一覧
ImportUnacceptedDataList
Import API を使用したデータの登録フロー
Import API を実行し、Import API のレスポンスボディから「operationID」を取得します。
Response Body
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
}ImportResult API を実行し、Import API の進捗状況を取得します。
この時、「1. Import API の実行」で取得した「operationID」をリクエストボディに指定します。
Request Body
POST https://api-sandbox.obc.jp/gl/importXXXXresult
Authorization: Bearer ******************************
X-OBC-SubscriptionKey: ******************************
X-OBC-TenantID: ***********
Content-Type: application/json; charset=utf-8
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
}
ImportResult API のレスポンスヘッダー「X-OBC-ContinuationToken」の値から、Import API の処理が「実行中」か「完了」かを判断します。
Response Body（「X-OBC-ContinuationToken」が未設定の場合）
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
"status": "Processing",
"startDateTime": "2019-11-25T06:44:49.6339263+00:00",
"unAcceptedReasonList": null
}
Import API の処理は「実行中」です。
再度、「2. ImportResult API の実行（進捗状況の取得）」を実行してください。
Response Body（「X-OBC-ContinuationToken」に値が設定されている場合）
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-OBC-ContinuationToken: abcdefg0123456789
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
"status": "Processing",
"startDateTime": "2019-11-25T06:44:49.6339263+00:00",
"unAcceptedReasonList": null
}
Import API の処理は「完了」しました。
続けて、「4. ImportResult API の実行（処理結果の取得）」を実行してください。
ImportResult API を実行し、Import API の処理結果を取得します。
この時、「1. Import API の実行」で取得した「operationID」をリクエストボディに指定します。
Request Body
POST https://api-sandbox.obc.jp/gl/importXXXXresult
Authorization: Bearer ******************************
X-OBC-SubscriptionKey: ******************************
X-OBC-TenantID: ***********
X-OBC-ContinuationToken: abcdefg0123456789
Content-Type: application/json; charset=utf-8
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
}
Response Body
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-OBC-ContinuationToken: tuvwxyz9876543210
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
"status": "Processing",
"startDateTime": "2019-11-25T06:44:49.6339263+00:00",
"unAcceptedReasonList": null
}
「status」には、以下の値が設定されます。
Processing：Import API の処理または結果データの生成・取得処理が実行中
Finished：すべての処理が完了
「status」が「Finished」になるまで、「4. ImportResult API の実行（処理結果の取得）」を繰り返し実行してください。
「X-OBC-ContinuationToken」は進捗状況によって変わります。
リクエストヘッダーに指定する値は、必ず前回実行時のレスポンスヘッダーの値を指定してください。
ImportResult API の受入結果のレスポンスを確認します。
結果データの取得が完了すると、レスポンスヘッダーの 「X-OBC-ContinuationToken」は未設定になります。
Response Body（すべて正常に受け入れできた場合）
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
"status": "Finished",
"startDateTime": "2019-11-25T06:44:49.6339263+00:00",
"unAcceptedReasonList": null
}
「unAcceptedReasonList」 は null になります。
Response Body（未受入のデータがある場合）
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"operationID": "e17dc570-be0d-4872-98a8-aeb5b29b5928",
"status": "Finished",
"startDateTime": "2019-11-25T06:44:49.6339263+00:00",
"unAcceptedReasonList": [
{
"index": 0, "key": "AA0010005",
"data": null,
"reason": "取得日付が指定されていません。"
},
{ ... }
]
}
「unAcceptedReasonList」 に失敗理由が記載されます。
参考
ImportResult API を繰り返し実行すると、レート制限に該当することがあります。
その場合は、間隔を空けて ImportResult API を実行してください。