このガイドでは、「DX Suite をシステム連携で活用したい」「APIで処理を自動化したい」方向けに、 API連携の基本手順を紹介しています。
準備から APIキー取得、連携開始まで順番に進めることができます。
APIとは
API（Application Programming Interface）は、ソフトウェアの機能を外部システムから実行する仕組みです。
DX Suite の標準API V2を利用することで、異なるソフトウェアとDX Suite を連携し、一連の処理を自動化できます。
この連携により、人の手を介さない処理が可能になり、業務効率の向上や生産性の改善につながります。
▼ 操作デモ動画：API連携の流れを確認しましょう
まずは、実際の画面を見ながらAPI連携の基本的な流れを確認してみましょう。
この動画では、以下のポイントを紹介しています。
- DX Suite APIの基本的な仕組み
- APIを使ったデータ取得の流れ
- システム連携のイメージ
文字だけでは分かりにくい部分も、動画を見ることでAPI連携の全体像をイメージすることができます。
まずは動画で概要を確認してから、下のセクションでAPIの仕様や利用方法を確認してみましょう。
APIの基本的な使い方
APIを利用する際の基本的な操作方法を以下に示します。
1. リクエストの作成
- 必要なヘッダーとパラメータを正確に設定します。
- エンドポイントとHTTPメソッド(GET、POSTなど)を指定します。
2. レスポンスの確認
- ステータスコードを確認し、200(成功)以外の場合の処理を実装します。
- レスポンスデータを解析し、必要な情報を抽出します。
3. 認証とセキュリティ
- APIキーで認証を行います。APIキーは安全に保管し、権限のないメンバーには共有しないでください。
不要になったAPIキーは速やかに削除してください。
標準APIの特徴
-
画面操作なしで指示が可能
標準APIを利用することで、DX Suite の操作を画面上で行う必要がなくなります。
たとえば、API経由で読み取り処理を指示し、作成されたユニットを画面上で確認・チェックすることが可能です。 -
業務効率の向上
APIを活用した自動化により、手動操作を減らし、時間やコストの削減を実現します。
その他のAPIについて
項目選択（旧非定型）および全文読取は、標準APIとは別に専用のAPIを提供しています。
これらのAPIでは、ワークフローを事前に設定する必要がなく、作成したユニットも画面上には表示されずに処理を実行できます。
チェック作業を省略できる場面や、読取結果を基に細かな制御を行いたい場合に、これらのAPIの活用をご検討ください。
詳細については、各APIの記事をご参照ください。
API関連リンク集
API利用に際してご参照いただける仕様書やリファレンスサイトをご用意しています。
ご利用の目的に応じて、各リンクをご確認ください。