架空の受注システムから出荷システムへ、注文N072を登録する例で考えます。受注側は「商品P01を10ケース」と、注文番号や納期等の必要な情報を送ります。出荷側はその依頼を受けるためのAPIを用意し、どの項目をどんな形式で受け付けるか決めます。

APIは、システムが使う窓口の決まりです。送信先、頼む操作、必要な項目、許可の確認、返す情報が仕様として用意されます。「APIがある」という説明だけでは、注文登録、照会、変更のどれができるか分かりません。今回つなぐ仕事を具体的に尋ねてください。

MicrosoftのAPI設計指針は、要求と応答を理解する技術上の参考です。本稿の項目と受付番号は教材用で、特定サービスの実際のAPI仕様ではありません。提供会社が公開する仕様を確認し、自社が必要な登録・照会を使えるかを照合します。

この章の根拠：出典1

N072の送信情報は、注文番号N072、商品コードP01、数量10、単位ケースとします。数量の10だけを送ると、10個か10ケースか分かりません。受け先が個単位だけを使う場合は、入り数と換算方法を業務担当と提供会社が確認します。

日付も、注文日、出荷希望日、到着希望日が違います。自社が10月15日を出荷希望日として使うなら、受け先の同じ意味の項目へ対応させます。項目名が似ているだけで一致とせず、意味、入力形式、空欄の場合の扱いを表へ書きます。

IPAの要件定義の観点を使い、連携で使うデータの構造と管理方法を整理します。入力例を提供会社へ渡す前には、自社で共有してよい架空資料や匿名化資料を使います。秘密の認証情報は項目対応表へ実値を書かず、担当が安全な設定方法を確認します。

この章の根拠：出典2

出荷側から受付番号R009と「受付」と返る架空例です。これは依頼を受け取ったという意味で、注文登録や出荷が終わったとは限りません。APIの応答は、通信の結果と業務処理の状態を分けて読む必要があります。

HTTPという通信の仕組みでは、201が新しい記録の作成、202が処理の受付を示す設計があります。Microsoftの指針も非同期の受付と完了を区別しています。ただし個別サービスが返す値や本文の意味はその仕様で確認し、数字だけから出荷状態を推測しません。

受付後の処理が続く場合、結果をどのAPIで照会し、いつ完了を判断するかを尋ねます。N072とR009の対応を送信記録へ残せば、受付の後に失敗した場合も担当が調べられます。受注側の「送信済み」だけで、出荷担当の仕事を完了表示にしないでください。

注文を送れるAPIでも、利用契約のプラン、使える回数、登録する情報の量、同時に処理できる数が違い得ます。自社の通常件数と集中する時間帯を提供会社へ伝え、制限の値と超えた場合の応答を確認します。本稿は特定サービスの上限を示しません。

認証は、どのシステムが許可された操作をするかを確認する仕組みです。注文を見るだけの権限で登録までできるとは限りません。接続担当が、必要な操作、権限の設定、期限切れや停止時の扱いを確認し、秘密値を一般の説明資料に載せない方法を決めます。

システムの更新でAPIの版が変わる場合、項目や応答の変更通知を誰が受けるかも決めます。最初の接続試験に成功したことと、使い続けられる運用は別です。制限、版、保守時間、追加料金の条件を同じ確認表へ残してください。

N072を送った後、通信が切れて応答が返らないことがあります。出荷側では登録済みなのに、返事だけ届かなかった可能性もあります。受注側に応答がないことから「未登録」と断定し、新しい注文として再送しないよう担当の判断を決めます。

AWSの指針は、同じ依頼を識別する番号で再送の重複を制御する考え方を説明しています。自社のAPIもその仕組みを持つとは限りません。提供会社へ同じ依頼を識別する方法、結果照会、同じ内容で再送できる条件を確認してください。

送信記録にはN072、送信時刻、依頼識別子、応答の有無、次の確認担当を残します。内容を変える場合は、同じ依頼の再送か注文変更かも仕様で区別します。担当が結果を照会できないときは、登録結果不明として保留し、窓口へ確認する運用を用意します。

この章の根拠：出典3

API連携は、決められた窓口へ情報を送り、応答を受ける仕組みです。N072の架空例では、商品P01、数量10ケースを送り、R009の受付を登録完了や出荷完了と分けました。何を送り何が返るかを説明できれば、接続の範囲を具体的に相談できます。

利用できる操作、項目の意味、回数と権限、保守や版の変更は提供会社の仕様で確認します。応答がない場合は未登録と決めず、同じ依頼の保存結果を調べます。つながることだけでなく、連携を止めずに確認し続ける担当の仕事も残してください。

次に、営業と出荷担当へつなぎたい注文1件を尋ね、下のメモへ項目と期待結果を書いてください。提供会社には受付後の照会方法、制限、再送条件を同じ例で質問します。未確認の条件を解消してから、今回の連携と試験の範囲を決めましょう。