API

プラグインKEY

「プラグインKEY」を利用することで不正な「更新」「情報取得」を防止することができます。
※ユーザーの作成だけは「プラグインKEY」がなくても動作します。

プラグインKEYを変更したい場合は「プラグインKEYを再発行する」をクリックします。確認ダイアログが表示されて「OK」をクリックすると新しいプラグインKEYが発行されます。
以前のプラグインKEYは無効となりますのでご注意ください。元のプラグインKEYに戻すことはできません。

ユーザーを作成する

指定のURLにアクセスをすると自動的に「ユーザー」が作成されて、条件項目の初期値が設定されます。ユーザーの登録時間も自動的に設定されます。

createUser を使って登録が成功するとJSON形式で登録情報が表示されます。
createUserName を使って登録が成功するとユーザーネームが表示されます。
※リダイレクト機能が追加されました (参照)

APIによるユーザー作成は、直接ユーザーがアクセスしていないのでIPアドレスはAPIを呼び出したサーバーになってしまいます。そこで下記のように「?ss_ip=」にてIPアドレスを指定することができます

例：https://example.com/w/ss/-/createUser?ss_ip=123.123.123.123

※値は、任意の文字列は指定できません。URLとして有効なものに限定されます。

ユーザー情報を更新する

指定されたユーザーの項目情報を複数同時に更新します。プラグインKEYが必須です。
変更が成功すると success、失敗すると error を出力します。

数値に対して文字を指定した場合などにerrorが発生します。
errorが発生した項目が表示されます。
表示例：error:price, のkeyでエラーが起こりました。

複数の更新で、errorが発生した場合でも success な更新は正常に更新されます。
例：price変更でエラー → 変更されない。itemname変更はsuceess → 変更される

ユーザー情報を取得する

指定されたユーザーの項目情報を表示します。プラグインKEYが必須です。
Step Sales のユーザー管理で表示される内容をJSON形式で出力します。