Site:API:UserCookieData

From Metrixstream
Jump to: navigation, search

Contents

User Cookie Data

User cookie data is essentially what you are used to with a webbrowser, but stored server side. The benefits of storing this data server side include the ability to have them persist across different computers. This means when a user logs in from home and work, the experience will be the same.

The big difference between a user cookie and a browser cookie, is that a user cookie requires an authenticated session.... meaning no anonymous preferences are supported. Note: you are not forced to choose one or the other, so you can mix and match each solution to fit your requirements.

Set User Cookie

This API call is responsible for setting a user cookie.

Authentication Restrictions

An authenticated user.

Required Parameters

  • action=usercookie
  • verb=set
  • name: the name of the user cookie.
this has a maximum of 48 characters.
  • value: the value of the user cookie.
this has a maximum of 1000 characters.

Successful Response

  • status=ok


Delete User Cookie

This API call is responsible for deleting a user cookie. The response will still succeed, if the cookie doesn't exist.

Authentication Restrictions

This API call is responsible for setting a user cookie.

Required Parameters

  • action=usercookie
  • verb=del
  • name: the name of the user cookie.

Successful Response

  • status=ok
Personal tools