OPENAPIの概要

OPENAPIの概要OPENAPIは、SHANONMARKETINGPLATFORM（以降、SMP）のデータをWEBサイトにJavaScriptとして手軽に公開できる軽量なAPIです。例えば、企業サイトへのイベントカレンダーの設置、展示会の出展者一覧の作成や来場者情報のグラフ化などが、HTMLとJavaScriptだけで構築することができます。※本ドキュメントを参照するにあたり、『SHANONMARKETINGPLATFORMAPI開発者ガイド』も合わせてご覧ください。OPENAPIの特徴SHANONMARKETINGPLATFORMAPIとOPENAPIの関係性についてOPENAPIの特徴OPENAPIにおける4つの特徴は、次のとおりです。高速なAPIデータをキャッシュし、独立したサーバーでリクエストを処理することで、高速なレスポンスを実現します。データはリアルタイムではなく、一定時間おきに更新されます。手軽な導入APIを直接参照する以外に、それらを簡易的に呼び出せるJavaScriptSDKを用意しています。SDKの関数をWEBページでコールするだけで簡単にデータを表示できます。セキュアな環境サーバー側でキャンペーンやリードといった各データごとに認証の有無の設定、アクセス元のIPアドレスの制限、出力するデータの絞り込みなどを設定できます。これにより、APIを使う側が特に意識しなくてもセキュアな情報提供が実現できます（これらの設定はシャノン担当者による作業が必要です）。優れた汎用性出力形式はJSONであるので、他のグラフツールや集計ツールとも相性のよい汎用性を持っています。注意OPENAPIはSMPデータをオープンデータとして公開する機能を持つため、公開データにリード情報のような個人データを含む場合、取り扱いについては十分注意してください。特定の個人に関する情報をオープンにする際、ログインしている本人にのみ公開する認証の設定または、IP制限を設けるなどの措置をとるようにしてください。SHANONMARKETINGPLATFORMAPIとOPENAPIの関係性についてSHANONMARKETINGPLATFORMAPI（以降、SMPAPI）とOPENAPIには仕様や用途に違いがみられます。違いについては、次のとおりです。比較項目SMPAPIOPENAPI同時リクエスト数1（並列コール不可）500程度まで可能（SDKの認証関数は2まで可能）パフォーマンス1秒以下〜10秒以上（データの種類や保存件数に依存）全データほぼ1秒以下データの完全性リアルタイム（マスターデータを提供）キャッシュデータ（一定時間おきに同期しているので古いものあり）可能なデータ操作登録、参照、更新、削除参照のみ認証APIキーによる認証認証なしか、SMPログインユーザによる認証ありかを選択可能アクセス制限IPアドレス制限可能IPアドレス制限可能操作可能なデータマーケティングプラットフォームに登録されているほぼ全データマーケティングプラットフォームに登録されているものから一部除いたものレスポンスフォーマットXMLJSONデータの絞り込みやソートパラメータで指定可能だが、指定できる項目に制限ありパラメータで全項目指定可能リードデータの選定不可（パラメータで指定する）可能（ログインしたリードのデータのみ表示可能）JavaScriptからの呼び出し不可可能（SDKあり）マーケティングプラットフォーム停止メンテナンス時の挙動データ参照、登録ともに不可データ参照は可能（但し、ネットワークメンテナンスやデータベースメンテナンス時を除く）想定用途外部連携システムとのサーバー間のデータ操作WEBサイトへのデータ表示