Synergy!
カスタマーサポートお問い合わせ
06-4797-2501

平日10:00-12:00/13:00-18:00

Synergy!API基本仕様書

1.機能の概要

ASPサービスSynergy!APIとはSOAP(※)を使用し、外部サービスからASPサービスSynergy!にあらかじめ設定された情報モデル(S!PersonおよびS!History)に対し、レコードの登録・参照・更新・削除を行うことができるAPIの機能です。
この機能を用いることでASPサービスSynergy!のマスタデータベースおよび履歴データベースに格納されている情報に対し、外部のシステムからでもレコードを操作することが可能となります。
この機能を利用してASPサービスSynergy!のデータベースと別のシステムのデータベースとの間でのデータ連携したり、ASPサービスSynergy!が提供するWebページ以外のWebページからのデータのレコード操作を行うといった用途で用いることができます。
※Simple Object Access Protocol:他のコンピュータにあるソフトウェア同士がデータやサービスを呼び出すためのプロトコル

2.「S!Person」について

S!Personとはマスターデータベースに対応する情報モデルで、S!Personが持つデータ項目は固定項目、基本項目と追加項目に分類されます。

  • 固定項目
    ASPサービスSynergy!にあらかじめ登録されている以下の項目はS!Personにおいて固定項目とし、常に取り扱うことができます。
    Synergy!ID、PCメールアドレス、携帯メールアドレス、更新日時、システム登録日時、メール受信拒否フラグ、PCメールエラーカウント、携帯メールエラーカウント、メルマガ解除フラグリスト
  • 基本項目
    以下の項目はS!Personにおいて基本項目とし、常に取り扱うことができますが、取り扱うためには予めそれぞれの項目をASPサービスSynergy!に設計したデータベース項目に関連づけておく必要があります。
    氏名、シメイ、都道府県、住所、郵便番号、電話番号、FAX、携帯電話番号、生年月日、パスワード
  • 追加項目
    固定項目、基本項目以外でマスターデータベースの任意のデータベース項目を100項目まで追加項目として取り扱うことができます。

3.「S!History」について

S!Historyとは履歴データベースに対応する情報モデルで、S!Historyが持つデータ項目は固定項目と追加項目に分類されます。

・固定項目
以下の項目はS!Historyにおいて基本項目とし、常に取り扱うことができます。
Synergy!ID、HistoryID

・追加項目
固定項目以外で履歴型データベースの任意のデータベース項目を20項目まで追加項目として取り扱うことができます。

4.機能提供におけるサービスレベル

ASPサービスSynergy!APIでは機能を提供するにあたり、努力目標として以下のサービスの基準を満たすよう、商業的に合理的な努力をもって機能を提供します。

  • 稼働率
    ASPサービスSynergy!APIの稼働率目標は月間で99%とします。
    ただし、稼働率の計算にあたり事前に予告された定期メンテナンスの時間は稼働率にかかる停止時間には含めないものとします。
  • 定期メンテナンス
    3ヶ月に一度程度、ASPサービスSynergy!APIを停止してのメンテナンス作業を実施いたします。
    実施にあたっては2週間前までに作業の日程およびサービス停止時間帯等をサービス利用者に対し通知いたします。
  • サポート
    問い合わせは原則としてAPI技術サポートお問い合わせフォームまたはメールでのお問い合わせのみとし、 お問合わせいただける内容はASPサービスSynergy!APIの機能仕様または稼働状況の確認に限定させていただきます。
    よって、ASPサービスSynergy!APIの機能を利用したシステム構築など、利用者側の技術等に依存する内容に関してのお問い合わせはお受けすることはできません。

5.機能の利用に関する制限

ASPサービスSynergy!APIをご利用いただく場合は、弊社の指定した以下の利用制限の範囲内でしかご利用いただくことはできません。
利用制限に反する利用等、弊社がASPサービスSynergy!の提供に相当の支障があると判断した場合はアクセス制限や機能自体の停止等の処置を行うことがあります。

  • 1秒あたりのリクエスト回数
    ASPサービスSynergy!の1契約単位からのリクエスト回数が1秒あたり50回を超えるような利用方法
  • 同一のリクエストの繰り返し
    1分程度の短時間の間に同じリクエストを何度も繰り返すような利用方法
  • 大量データの登録
    10万件を超えるデータの登録を数時間に渡って継続するような利用方法
2015年07月15日 初版作成
2020年03月15日 改定
© 2015- Synergy Marketing, Inc.