データベースAPI

1.データベースAPIとは

データベースAPIは外部のシステム、データベースからSynergy!データベースの読み出し、登録・更新・削除などを簡単に行うことができるAPIです。
Synergy!のセキュリティ性や豊富な機能を生かしたシステム開発などを簡易・短期間に行うことができます。

データベースAPIの仕様書はこちらをご覧ください。

※データベースAPIのご利用は無料です。お申し込みも不要です。

※データベースAPIは、Synergy!のルールや仕様を公開しているだけの機能です。
データの参照や登録などを行うには、そのルールや仕様に合わせて、お客様にて
プログラムを自作し外部システムとの連携を設定していただく必要があります。

※お問い合わせはAPI技術サポートお問い合わせフォームより受付しています(メール対応のみ)。なお、プログラムの具体的な記述方法についてはサポート対象外としております。あらかじめご了承ください。

2.API管理の一覧

①アカウントコードを表示します。
APIをコールする際にパスパラメータとして利用します。

②データベースAPIのON/OFFを切り替えます。

③クライアント認証キーを新規作成します。
※10個まで作成できます。

④クライアント認証キーを検索します。
検索可能な項目は「クライアント認証キー」「メモ」「最終更新者(ユーザ名)」です。

⑤クライアント認証キーとメモを表示します。

⑥選択したスコープを表示します。

⑦最終更新日時と操作ユーザ名を表示します。

⑧クライアント認証キーを編集します。

⑨クライアントシークレットを再発行します。
※再発行すると前回発行されたクライアントシークレットは無効になります。

⑩クライアント認証キーを削除します。

3.利用開始までの流れ

1.事前準備

仕様書をご覧いただき、どのスコープが必要か確認してください。
また、接続元のIPアドレスを制限される場合は、IPアドレスの確認も行ってください。
※開発ベンダに依頼する場合は仕様書のURLを共有し、必要なスコープと許可するIPアドレス(接続元のIPアドレスを制限される場合のみ)を確認するようご依頼ください。

2.初期設定(管理画面)

その他>共通設定>API管理より、データベースAPIを「ON」に切り替え、クライアント認証キーとクライアントシークレットを発行します。

操作には、API管理権限が必要です。

1.Synergy!データベースAPIの「OFF」をクリックし、「ON」に切り替えます。


2.利用規約を読み、チェックボックスにチェックを付与して「利用を開始する」をクリックします。


3.クライアント認証キー一覧の「新規作成」をクリックします。

クライアント認証キーは10個まで作成できます。

4.クライアント認証キーを設定します。

①クライアント認証キーに許可するスコープへチェックを付与します。
db:openapi:read    ・・・ 作成したAPI定義の参照が可能です
db:apidefinition:design ・・・ データベース設定情報やAPI定義の参照/編集が可能です
db:record:execute    ・・・ 作成したAPI定義によるレコード操作が可能です

②接続元のIPアドレス制限を設定します。利用する際は「有効」を選択してください。

③接続元の許可IPアドレスを指定します。※②で「有効」に設定した場合のみ
 IPv4形式もしくは、CIDR形式で入力してください。

複数のIPアドレスを指定する場合は、改行区切りで入力してください。
※「*」(アスタリスク)を利用した範囲指定はできません。

④管理用メモを入力します。
 クライアント認証キー一覧で表示され、検索にも利用できます。

管理用メモは256文字まで登録できます。

5.クライアント認証キーとクライアントシークレットが発行されます。

クライアントシークレットは再表示できません。画面キャプチャを取得するか、コピーボタンよりコピーして取得してください。

<クライアントシークレットを取得できなかった時は・・・>
クライアント認証キー一覧画面にある「編集」ボタン右横の▼より「クライアントシークレット再発行」を実行して、新しいクライアントシークレットを発行してください。
※再発行すると前回発行されたクライアントシークレットは無効になります。

3.開発する

仕様書を参考にプログラムを構築してください。
開発ベンダに依頼する場合は、下記をお渡しください。
・アカウントコード(API管理の一覧で取得)
・クライアント認証キー と クライアントシークレット(「2.初期設定(管理画面)」で取得)

この記事は参考になりましたか?
参考になった参考にならなかった
読み込み中...
この記事への評価、ご指摘がございましたらご入力ください。
※ご入力内容への回答はできません。ご質問はフォームよりお問い合わせください。