1. コーデンベルク サービスデスク
  2. ご利用ガイド
  3. ご利用の流れ
  4. 2. セットアップ：API連携編
API連携を行わない方は3. セットアップ（製造リハーサルと公開）へお進みください

コーデンベルクAPIを利用して、自動で注文連携を行うフロント側のシステム（以下フロントシステム）を構築いただくまでの流れをご案内します。

手順

1. API連携イメージの確認
2. API仕様の確認
3. APIの実装
4. API連携テスト

1. API連携イメージの確認

フロントシステムとコーデンベルクのAPI連携イメージは以下の通りです（クリックで拡大）。

img_API.png

2. API仕様の確認

コーデンベルクで提供しているAPIの仕様を確認します。
ログイン後、「API」ページ「APIリファレンス」からご確認いただけます。今回のシステム連携時に実装が必要となるAPIの選定や必要となるパラメータ、エラーハンドリングなどの仕様を検討してください。

3. APIの実装

各APIの呼び出しには、以下の各種IDが必要になります。それらを利用して実装を進めてください。

  • APIキー・シークレットキー
    ログイン後、「API」ページから確認いただけます。
    API__.png

  • テンプレートID・可変領域ID
    ログイン後、「テンプレート」>「テンプレート詳細」ページより（デザイナーによるテンプレート登録完了後）ご確認いただけます。

  • 素材ID
    ログイン後、「素材」>「素材詳細」ページより（デザイナーによる素材登録の完了後に）ご確認いただけます。

4. API連携テスト

システム構築が完了したら、連携テストを進めます。

  1. ログイン後、「テンプレート」>「テンプレート詳細」ページから対象テンプレートを「API公開」にし、APIから利用可能な状態にしておきます。

    テンプレート詳細画面の右上にある「API非公開・公開」のスイッチを切り替え、「API公開」にします。
    切り替え後、ページ右をスクロールし、最下部にある［保存］をクリックすると、テンプレートのAPI公開が完了します。
     
    ① 詳細ページへ進む
    api_Release_0.png
     
    ② スイッチの切り替え
    api_Release_1.png
     
    ③ ページ右をスクロールし［保存］をクリック
    　　　　api_Release_2.png
     
  2. 次に、ログイン後ページ左下にある「APIライブモード」が「無効」になっていることを確認します。

    - FAQ「APIライブモードとは何ですか」
    ※ 「APIライブモード」を「有効」の状態でAPI注文すると、実際に印刷会社での製造が行われるため費用発生の対象となりますのでご注意ください


  3. フロントシステムにて注文処理を行います。

  4. コーデンベルクの「注文履歴」>「注文詳細」ページより、コーデンベルクに注文が正しく受け付けられていることを確認します（注文履歴ページでは、テスト注文を「テストモード印刷」のステータスで表しています）。

  5. APIエラーが発生した場合は、「API」ページ下部にございます APIエラーログ をご確認ください。
    API______1.png

 

- 関連記事