OPEN APIの概要

SHANON MARKETING PLATFORM OPEN APIとは?

OPEN APIは、マーケティングプラットフォームのデータをWEBサイトにJavaScriptとして手軽に公開できる軽量APIです。
企業サイトへのイベントカレンダーの設置、展示会の出展者一覧の作成や来場者情報のグラフ化などが、HTMLとJavaScriptだけで構築することができます。

※本ドキュメントを参照するにあたり、『SHANON MARKETING PLATFORM API開発者ガイド』も合わせてご覧ください。

4つの特徴

  1. 高速なAPI
    データをキャッシュし、独立したサーバーでリクエストを処理することで、高速なレスポンスを実現します。
    データはリアルタイムではなく、一定時間おきに更新されます。

  2. 手軽な導入
    APIを直接参照する以外に、それらを簡易的に呼び出せるJavaScript SDKを用意しています。SDKの関数をWEBページでコールするだけで簡単にデータを表示できます。

  3. セキュアな環境
    サーバー側でキャンペーンやリードといった各データごとに認証の有無の設定、アクセス元のIPアドレスの制限、出力するデータの絞り込みなどを設定できます。これにより、APIを使う側が特に意識しなくてもセキュアな情報提供が実現できます(これらの設定はシャノン担当者による作業が必要です)。

  4. 優れた汎用性
    出力形式はJSONであるので、他のグラフツールや集計ツールとも相性のよい汎用性を持っています。

個人データの取り扱いについて

OPEN APIはSMPデータをオープンデータとして公開する機能を持つため、公開データにリード情報のような個人データを含む場合、取り扱いについては十分注意してください。特定の個人に関する情報をオープンにする際、ログインしている本人にのみ公開する認証の設定または、IP制限を設けるなどの措置をとるようにしてください。

マーケティングプラットフォームAPIとOPEN APIの関係

マーケティングプラットフォームAPIとOPEN APIには仕様や用途に違いがみられます。以下がその内容となります。

表 1. マーケティングプラットフォームAPIとOPEN APIの比較
比較項目 マーケティングプラットフォームAPI OPEN API

同時リクエスト数

1(並列コール不可)

500程度まで可能

パフォーマンス

1秒以下〜10秒以上(データの種類や保存件数に依存)

全データほぼ1秒以下

データの完全性

リアルタイム(マスターデータを提供)

キャッシュデータ(一定時間おきに同期しているので古いものあり)

可能なデータ操作

登録、参照、更新、削除

参照のみ

認証

APIキーによる認証

認証なしか、SMPログインユーザによる認証ありかを選択可能

アクセス制限

IPアドレス制限可能

IPアドレス制限可能

操作可能なデータ

マーケティングプラットフォームに登録されているほぼ全データ

マーケティングプラットフォームに登録されているものから一部除いたもの

レスポンスフォーマット

XML

JSON

データの絞り込みやソート

パラメータで指定可能だが、指摘できる項目に制限あり

パラメータで全項目指定可能

リードデータの選定

不可(パラメータで指定する)

可能(ログインしたリードのデータのみ表示可能)

JavaScriptからの呼び出し

不可

可能(SDKあり)

マーケティングプラットフォーム停止メンテナンス時の挙動

データ参照、登録ともに不可

データ参照は可能(但し、ネットワークメンテナンスやデータベースメンテナンス時を除く)

想定用途

外部連携システムとのサーバー間のデータ操作

WEBサイトへのデータ表示

検索結果 ""

    検索結果がありません ""