こんにちは。LINEでテクニカルエバンジェリストとしてLINEのAPIを利用したデベロッパーのビジネスの成功をお手伝いさせていただいている立花です。
LIFF(LINE Front-end Framework)のv2がリリースされ、In App Browserや外部ブラウザからも利用できるようになりました。LIFFについてはこちらの記事を参照下さい。
※ QRコードは(株)デンソーウェーブの登録商標です
主な変更点
LINEアプリ以外の環境への対応
v1では、liff.init()
等の関数はiOSもしくはAndroid搭載端末においてline://app
で始まるURLをリクエストした際にLINE上で開くViewのみで動作しておりましたが、v2ではIn App Browserや外部ブラウザからの利用も想定し、認証処理やメッセージの送信が強化されています。
ユーザーのメールアドレスが取得できるように
LINEログイン v2.1との互換性が向上し、ユーザーのメールアドレスの取得が可能になりました。
クライアントAPIの追加
それに伴い、新たに追加された機能を簡単に利用することができるAPIが追加されています。
関数名 | サポートバージョン |
---|---|
liff.init(successCallback, errorCallback) | v1 |
liff.init(config, successCallback, errorCallback) | v2 |
liff.openWindow() | v1 |
liff.getAccessToken() | v1 |
liff.getProfile() | v1 |
liff.sendMessages(messages) | v1 |
liff.closeWindow() | v1 |
liff.initPlugins(["bluetooth"]) | v1 |
liff.getOS() | v2 |
liff.getLanguage() | v2 |
liff.getVersion() | v2 |
liff.isInClient() | v2 |
liff.isLoggedIn() | v2 |
liff.login() | v2 |
liff.logout() | v2 |
liff.getAccessToken() | v2 |
liff.scanCode() | v2 |
使い方
liff.init(config, successCallback, errorCallback)
SDK v2 を使用開始するために、必ずページ読み込み完了後に実行が必要となる API です。
SDK v2 では LIFFを利用する場合はliffId
を渡す必要があるため、config
は必須のパラメータとなります。
詳しくはこちらを参照して下さい。
liff.getOS()
ios
、android
、web
いずれかの値を返します。
詳しくはこちらを参照して下さい。
liff.getLanguage()
LIFFアプリ(LIFF SDKを導入したWebアプリケーションを指します)を動作させている環境の言語設定を文字列で返します。
詳しくはこちらを参照して下さい。
liff.getVersion()
LIFF SDKのバージョンを文字列で返します。
詳しくはこちらを参照して下さい。
liff.isInClient()
サービスがLINEアプリ上からアクセスされているかどうかを返します。
詳しくはこちらを参照して下さい。
liff.isLoggedIn()
ユーザーがLINEのアカウントを利用してログインしている状態の場合はtrue
を返します。true
の場合、アクセストークンが必要なAPIを呼び出すことが可能です。
詳しくはこちらを参照して下さい。
liff.login()
ユーザーをLINEログイン画面へ遷移させます。任意の引数loginConfig.redirectUrl
を設定することでログイン後に遷移する先を指定できます。指定しない場合はLIFFのエンドポイントとして設定したURLに遷移されます。
ログイン成功時はクッキーにデータが保存されますので、遷移先においても認証が必要なクライアントAPIの利用が可能です。
なお、本APIはLINEアプリ上以外のブラウザからのアクセスの場合のみ利用できます。
詳しくはこちらを参照して下さい。
liff.logout()
ユーザーをログアウトさせます。
詳しくはこちらを参照して下さい。
liff.getAccessToken()
アクセスしているユーザーのアクセストークンを取得します。
詳しくはこちらを参照して下さい。
liff.scanCode()
QRコードリーダーを起動します。読み取った結果は文字列の形でコールバック関数に渡されます。
なお、本APIはLIFFアプリにScanQR権限が付与済みかつ、LINEアプリ上で起動された時のみ利用できます。
詳しくはこちらを参照して下さい。
まとめ
v2へのアップデートにより、マルチプラットフォーム対応のWebアプリケーションにLINEを利用した認証を簡単に組み込めるようになりました。
LINEは国内で月間8,100万ユーザーが利用しており、LIFFの他にもMessaging APIやLINE Pay APIなど、サービスの開発に役立つたくさんのAPIを提供しております。
APIをうまく活用した、良質なサービスの登場を心待ちにしております。
なおドキュメントはこちらです。