DataStore および DataStore APIからの移行

注意事項

DataStoreおよびDataStore APIは標準機能としての提供を2020年5月12日に終了いたしました。現在は移行期間中となります。 同様の機能はDataStore V2およびDataStore V2 APIでオプションとして提供されます。 今後、sakura.io上で通信したデータの保存を希望する場合は データ保存機能(DataStore V2)仕様 および DataStore V2 API をご覧ください。

ここでは、 従来sakura.ioの標準機能として提供していたDataStoreの環境を、オプションのデータ保存機能として提供するDataStore V2で利用するために必要な移行手順ついて説明します。 sakura.io外部のサービスについては様々なケースが想定されるため、一般的な内容として記載いたします。

前提

移行の対象者:現在DataStore APIを利用しており、DataStore V2 APIに移行のうえ継続利用を希望される方。

Note

DataStoreおよびDataStore APIを利用していない方、および新規にDataStore V2およびDataStore V2 APIを利用される方は対応いただく必要はありません。

移行手順

データ保存機能(DataStore V2)の有効化

機能の有効化 を参考にコントロールパネルからDataStore V2を有効化します。

連携サービス DataStore V2 API の追加

連携サービスの新規追加 を参考にコントロールパネルから DataStore V2 API を追加します。

リクエスト内容の見直し

DataStore APIからの変更点 を参考に外部のシステムからDataStore APIに対して発行していたリクエストを見直します。

例えば、 2020年4月21日以降 かつ 直近10件 のメッセージを 降順 で取得する場合、リクエストはDataStore APIからDataStore V2 APIに移行する際には以下のように変更します。 なお、以下では作成したDataStore V2 APIのTokenを _token_ 、モジュールごとの固有のIDを _module_id_ とします。

DataStore APIの場合
$ curl -X GET --header 'Accept: application/json' 'https://api.sakura.io/datastore/v1/messages?token=_token_&module=_module_id_&size=10&order=desc&after=2020-04-21T00%3A00%3A00%2B09%3A00'
DataStore V2 APIの場合
$ curl -X GET --header 'Accept: application/json' 'https://api.sakura.io/datastore/v2/messages?token=_token_&module=_module_id_&limit=10&order=DESC&after=2020-04-21T00%3A00%3A00%2B09%3A00'

Note

DataStore V2 APIでは一部削除されているパラメータが存在するため、該当するパラメータを利用されている場合は戻りのデータのパースやリクエスト前の処理の改修が必要となる場合があります。