LステップのAPIリファレンスで確認できる項目と操作を解説

LステップのAPIリファレンスで確認できる項目と操作を解説

本記事では、LステップAPIリファレンス(仕様書)の内容と、確認できる項目・操作について整理して解説します。

 

この機能は高度な設定となります。設定の際は十分にご注意ください。

 

また、弊社サポートでは記事に関する質問は完全にお答えしきれない可能性があります。ご了承いただきますようお願い申し上げます。

 

また、利用にあたって気を付けることを記載しましたので、こちらも必ずご確認ください。

 

API連携については、【Lステップ×AI 外部連携セミナー】(オンライン/参加費無料)も開催していますので、ご興味がある方は無料セミナーにお越しください。

 

LステップのAPIリファレンス(仕様書)

Lステップでは、API連携の仕様をまとめた「APIリファレンス(仕様書)」を公開しています。

 

自社システムや外部ツールからLステップを操作する際に必要な情報がまとまっており、

認証方法から各エンドポイントの仕様、リクエスト・レスポンス例まで確認することが可能です。

 

以下のリンクより参照できます。

LステップのAPIリファレンス(仕様書)で確認できる内容と操作

LステップのAPIリファレンス(仕様書)で確認できる内容と操作を解説します。

APIリファレンス(仕様書)で確認できる内容

APIリファレンス(仕様書)では、主に以下の内容を確認できます。

  • 認証方法(アクセストークン方式)
  • 各エンドポイントの仕様
  • リクエスト、レスポンスの形式
  • cURLによるリクエストサンプル

 

実装時に必要となる情報が一通り整理されており、各操作ごとに具体的なリクエスト例を確認しながら開発を進めることができます。

APIリファレンス(仕様書)の内容で実行できる主な操作

APIリファレンス(仕様書)の内容で実行できる主な操作は、以下のとおりです

 

友だち
  • 友だち一覧の取得
  • 友だちの詳細情報を取得
  • 友だちのタグ追加
  • 友だちのタグ解除
  • 友だちの対応マーク設定
  • 友だちが通過した流入経路一覧の取得
友だち情報
  • ​​友だち情報フォルダの作成
  • 友だち情報の作成
タグ
  • タグフォルダ一覧の取得
  • タグフォルダの作成
  • タグ一覧の取得
  • タグの作成
  • タグの更新
  • タグに紐づく友だち一覧の取得
  • タグを友だちに一括追加
  • タグから友だちを一括削除
対応マーク
  • 対応マーク一覧の取得
トーク情報
  • トーク履歴の取得
共通情報
  • 共通情報フォルダ一覧の取得
  • 共通情報一覧の取得
  • 共通情報の更新
流入経路
  • 流入経路を通過した友だち一覧の取得
メディア
  • メディア一覧の取得
  • メディアの保存
テンプレート
  • テンプレート一覧の取得

 

これらの操作はすべてAPI経由で実行でき、外部システムからLステップのデータを取得・更新することが可能です。

まとめ

LステップAPIリファレンス(仕様書)の内容と、確認できる項目・操作について解説しました。

 

現在提供しているAPIは第一弾となり、お客様のご要望やユースケースに応じて、継続的にAPI群を拡張していく予定です。

 

ぜひ自社の運用にお役立てください。

 

Lステップを詳しく理解したい方

無料 オンライン説明会に参加する

Lステップを使ってみたい方

無料 トライアルに申し込む

監修者

高橋 直也

高橋 直也

ソーシャルデータバンク株式会社
執行役員 顧客統括

元システムエンジニアであり、技術者とマーケッターの間の調整役として重要な役割を果たす。2018年に株式会社Maneqlに入社し、創業メンバーとしてLステップのマーケティングとカスタマーサクセスを支え、年商30億円の達成に貢献。常務取締役員として経営全般を担い、400を超える代理店の運営や新システムの開発を主導。現在、LINE公式アカウントを用いたマーケティングとコンサルティングに注力。豊富な経験と専門知識を活かし、Lステップ事業の新たなマーケティング戦略を強化中。