1. コーデンベルク サービスデスク
  2. ご利用ガイド
  3. ご利用の流れ
  4. 2. セットアップ：API連携編

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

API連携を行わない方は3. セットアップ（製造リハーサルと公開）へお進みください

目次
1.　APIの連携イメージを確認する
2. APIの仕様を確認する
3. APIを実装する
4. APIの連携テストを行う

APIの連携イメージを確認する

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

img_API.png

APIの仕様を確認する

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

APIを実装する

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

  • APIキー・シークレットキー
    トップページ > API　から確認いただけます。
    API__.png

  • テンプレートID・可変領域ID
    トップページ > テンプレート > テンプレート詳細　よりご確認いただけます。
    （事前にテンプレート登録が必要です）

  • 素材ID
    トップページ > 素材 > 素材詳細　よりご確認いただけます。
    （事前に素材登録が必要です）

APIの連携テストを行う

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

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

    ① 登録テンプレート一覧からテンプレート詳細に進みます。
    ② テンプレート詳細画面の右上にある［API非公開・公開］のスイッチを切り替えます。
    ③ ダイアログにメッセージ（API公開に設定しました）が表示され、API公開作業の完了です。
     
    ① 詳細ページへ進む
    api_Release_0.png
     

    ② スイッチの切り替え

    api_Release_1.png
     

    ③ ダイアログのメッセージを確認

     api_Release_3.png
     
  2. 次に、ログイン後ページ左下にある「APIライブモード」が「無効」になっていることを確認します。

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


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

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

  5. 左メニュー > API　では、APIエラーが発生した場合 APIエラーログ がご確認いただけます。
    API______1.png

 

- 関連記事