外部API連携（APIリファレンス・使い方）

外部システムとAnimal Officeのデータを連携するためのREST APIです。

できること

• 受注の作成・取得・更新・削除・出荷処理
• 商品の作成・取得・更新・削除・バリエーション一括更新
• 取引先の作成・取得・更新・削除
• 商品分類マスタのCRUD操作
• 取引先分類マスタのCRUD操作
• Zapier・Power Automate・Shopifyなどのノーコードツールとの連携

基本的な使い方

APIドキュメント: https://api.animal-office.jp/redoc

APIキーの取得

1. サポートチームにAPIキーの発行をご依頼ください
2. sk_ で始まるAPIキーが発行されます
3. APIキーは発行時に一度だけ表示されます。安全な場所に保存してください

APIリクエストの送信

1. リクエストヘッダーに X-API-Key: <発行されたAPIキー> を追加します
2. ベースURL https://api.animal-office.jp/v1 に対してリクエストします
3. レスポンスはJSON形式で返ります

受注の作成例

1. POST https://api.animal-office.jp/v1/sales-orders にリクエストします
2. リクエストボディに受注日・得意先コード・明細をJSON形式で指定します
3. 成功するとステータス201でレスポンスが返ります

データのページネーション

1. 一覧取得では page（ページ番号）と size（1〜100件）パラメーターを指定します
2. レスポンスの total_count で総件数を確認できます
3. デフォルトは20件、最大100件取得できます

注意事項

• APIキーは sk_ で始まる文字列です。紛失した場合は再発行が必要です
• 1ページで取得できる件数は最大100件です
• 受注の更新は PUT で全フィールドを上書きします
• 取引先の更新は PATCH で送信フィールドのみ更新します
• 商品・取引先の削除は、他のデータに紐づいている場合は400エラーになります

関連ページ

• 外部APIとは何ですか？
• 外部APIの認証方法を教えてください
• 外部APIで操作できるデータの種類を教えてください
• 外部APIのエンドポイントURLを教えてください
• 外部APIで1回のリクエストで取得できる件数に上限はありますか？
• 外部APIで受注を作成するにはどうすればいいですか？
• 外部APIで取引先を取得・作成するにはどうすればいいですか？
• 外部APIで商品を取得・作成するにはどうすればいいですか？
• 外部APIで取引先を削除できますか？
• 外部APIで商品の外部IDと外部URLを管理できますか？