Contents
API連携の前提条件:得意先コード体系の確認
API連携を開始する前に、得意先コード体系が一致しているかを必ず確認してください。コード形式の不一致は、データ送信時にエラーとなる原因となります。
CSV送信と得意先コードの基本ルール
得意先コードに関する注意点やCSV送信時の検証手順を整理します。
- 得意先コードの形式: 大文字・数字が中心ですが、プラットフォームによっては特殊文字が許容される場合があります(例: 「C-0123」)。
- CSVファイルの構造: ヘッダーや項目名に空白や記号を含めないことが推奨されます。
認証設定と認可コード取得フロー
APIとの通信は、OAuth2.0認証プロセスで行われます。認可コードを取得するための手順を確認してください。
OAuth2.0認証プロセスの流れ
以下に認証フローの主なステップを示します。
- クライアントIDとシークレットの取得
-
BtoBプラットフォームの管理画面から、API連携用の資格情報を発行する(※具体的な値はシステムに依存)。
-
認可コードを要求するリクエスト送信
http
POST /auth/oauth/token HTTP/1.1
Host: [API_ENDPOINT]
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}
- 認可コードとアクセストークンの取得
- 成功時、レスポンスでアクセストークン(Access Token)が返される。
セキュリティ対策の要点: トークンを長期間有効にしないこと、定期的な更新やロールアウトの検討が必要です。
GET/POSTリクエストサンプルコードとCSV送信例
API通信では、GET・POSTリクエストを使用してデータ取得または送信を行います。以下は一般的な構造です。
GETリクエストの実装例
|
1 2 3 4 |
GET /api/v1/invoices HTTP/1.1 Host: [API_ENDPOINT] Authorization: Bearer {ACCESS_TOKEN} |
- 目的: 既存の請求書データを取得。
- パラメータ:
limit=10,offset=0等でページネーションを指定可能。
POSTリクエストでのCSVデータ形式
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
POST /api/v1/invoices/batch HTTP/1.1 Host: [API_ENDPOINT] Authorization: Bearer {ACCESS_TOKEN} Content-Type: application/json { "data": [ { "**得意先コード**": "A001", "**請求日**": "2026-07-05", "**金額**": "30000" }, { "**得意先コード**": "B002", "**請求日**": "2026-07-06", "**金額**": "45000" } ] } |
| 項目 | 値 | 補足 |
|---|---|---|
| 得意先コード | 必須項目 | 大文字・数字のみ有効(プラットフォーム依存) |
| 請求日 | 年月日形式(YYYY-MM-DD) | 空白不可 |
| 金額 | 数値型(整数) | 小数点はサポート不可(一部プラットフォームでは可) |
マスタデータ同期のタイミング管理
マスタデータ(得意先情報や商品コードなど)は、システム連携において正確性が求められます。適切なタイミングで同期を行う必要があります。
初期導入時の同期手順
以下はマスタデータを効率的に同期するためのステップです。
- 得意先情報をCSV形式で一括取得
-
既存のBtoBプラットフォーム内データをCSV出力し、ローカルに保存する。
-
内部システムとのコード体系整合性確認
-
得意先コードが一致していない場合は、変換マップを作成して対応させる。
-
同期用APIリクエストの実行
http
POST /api/v1/master/data HTTP/1.1
Host: [API_ENDPOINT]
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json
{
"type": "customer",
"data": [
{"code": "A001", "name": "〇〇株式会社"},
{"code": "B002", "name": "△△商事"}
]
}
失敗例の教訓: マスタデータを同期せずに直接請求書送信を行うと、コードが存在しない得意先に対してエラーが発生します。
消込結果反映の注意点とエラーハンドリング
API経由で送信したデータが処理されたか、消込結果を確認する必要があります。失敗時には再送信ルールに従って対応します。
処理ステータスコードの確認方法
- 成功時: HTTPステータスコード
200 OKが返される。 - 失敗時: 以下のようなエラー情報を含むレスポンスが送られる。
|
1 2 3 4 5 6 |
{ "status": "error", "message": "**得意先コード A001 を見つけることができません**", "code": "404" } |
| ステータスコード | 内容 | 対応方法 |
|---|---|---|
| 200 OK | 正常処理完了 | 消込結果を反映する |
| 400 Bad Request | データ形式不正 | CSV内容を再確認し、修正して送信 |
| 404 Not Found | レコードが存在しない | 得意先コードの整合性をチェック |
異常時の再送信ルール
- エラー発生時は、1時間後に同じデータを再送信する。
- 同じエラーが3回続く場合は、手動でエラーログを確認し、根本原因を特定する。
重要ポイント: BtoBプラットフォームごとに消込結果の反映タイミングや処理フローが異なるため、実装前には公式ドキュメントで確認が必要です。