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

API をご利用いただく場合、事前に Synergy! の利用登録が必要になります。
利用登録がまだお済みでない方は Synergy! 公式ページよりお問い合わせください。

また、API の利用には Synergy! データベース API 契約規定 が適用され、API を利用すると契約規定に同意したものとみなされます。

管理画面上の API 管理からクライアント認証キー、クライアントシークレットの発行を行なってください。 発行時アクセス可能な IP アドレスを設定することで、指定した IP アドレス以外からのリクエストを制限することができます。

Synergy!データベースAPI にアクセスするためには、リクエストヘッダーに発行したクライアント認証キー、クライアントシークレットを使用して取得したアクセストークンを付与する必要があります。
アクセストークンは事前に Synergy! 認可サーバ (https://auth.paas.crmstyle.com/oauth2/token) から OAuth 2.0 のクライアント・クレデンシャルズフローにより取得します。
アクセストークンには有効期限が設定されており、切れるまでアクセストークンは有効です。Synergy!データベースAPI へアクセスするたびにアクセストークンを取得しないようにしてください。

アクセストークン取得

リクエストURL

https://auth.paas.crmstyle.com/oauth2/token

リクエストヘッダー

リクエストパラメーター

scope一覧

リクエストサンプル

AUTHHEADER=`echo -n ${CLIENT_ID}:${CLIENT_SECRET} | base64 -w0`  
SCOPES="db:apidefinition:design db:openapi:read db:record:execute"
curl -i -X POST \
  -H "Authorization: Basic ${AUTHHEADER}" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  https://auth.paas.crmstyle.com/oauth2/token \
  -d "grant_type=client_credentials&scope=${SCOPES}&audience=https://db.paas.crmstyle.com"

レスポンス

レスポンスは JSON 形式で返却されます。

レスポンスサンプル

{
  "access_token": "{Access Token}",
  "expires_in": 3599,
  "scope": "db:apidefinition:design db:openapi:read db:record:execute",
  "token_type": "bearer"
}

レスポンス JSON プロパティ

Synergy!データベースAPI リクエスト

リクエストの際、Authorization ヘッダーにアクセストークンをセットしてください。

listApiDefinition リクエストサンプル

curl -X GET \
  -H "accept: application/json" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  https://db.paas.crmstyle.com/apis/apidefinition.database/v1/accounts/{accountCode}/apidefinitions

1. 認証情報取得

認証をご参照ください。

2. Record 定義登録

データモデルを OpenAPI V3 Schema 形式で定義し ApiDefinition.putApiDefinition から定義を登録します。
定義を登録することで Synergy! データベースに項目が作成され API に紐付けされます。Synergy! データベースに作成されている既存項目を定義登録に使用したい場合、既存項目を API に定義する を参照してください。

3. Record 利用

2で登録された API を Record より実行してください。

APIクライアントについて

作成された API は OpenAPI Specification で定義されています。 OpenApi より OpenAPI Document を取得することで、ご利用の開発言語に応じて API クライアントの自動生成が可能です。 コード生成ツールは OpenAPI.Tools をご参照ください。

同時リクエスト数の制限には、トークンバケットモデル（アカウントごとに、レート：10/sec、バースト：100）を採用しています。
ブロック発生時は、レスポンスコード：429 Too Many Request を返しますので、数分後に再度お試しください。

サーバ間連携用の独自の REST API を作成することができます。