LoudVoice API \ Author Sessions
LoudVoice API Resources
Resource/URI - Discussions | GET | POST | PUT | DELETE |
---|---|---|---|---|
Discussions
/loudvoice/discussions.json
|
List all discussions | Create a discussion | – | – |
Discussion
/loudvoice/discussions/<discussion_token>.json
|
Read a discussion | – | Update a discussion | Delete a discussion |
Discussion messages
/loudvoice/comments/<discussion_token>/comments.json
|
Read discussion comments | – | – | – |
Resource/URI - Authors | GET | POST | PUT | DELETE |
---|---|---|---|---|
Authors
/loudvoice/authors.json
|
List all authors | Create an author | – | – |
Author
/loudvoice/authors/<author_token>.json
|
Read an author | – | Update an author | Delete an author |
Resource/URI - Author Sessions | GET | POST | PUT | DELETE |
---|---|---|---|---|
Author Sessions
/loudvoice/authors/sessions.json
|
List all sessions | – | Create or update a session | – |
Author Session
/loudvoice/authors/sessions/<session_token>.json
|
– | – | – | Delete a session |
Resource/URI - Comments | GET | POST | PUT | DELETE |
---|---|---|---|---|
Comments
/loudvoice/comments.json
|
List all comments | Create a comment | – | – |
Comment
/loudvoice/comments/<comment_token>.json
|
Read a comment | – | Update a comment | Delete a comment |
Resource/URI - Votes | GET | POST | PUT | DELETE |
---|---|---|---|---|
Votes
/loudvoice/votes.json
|
List all votes |
– | – | – |
Vote
/loudvoice/votes/comments/<comment_token>/authors/<author_token>.json
|
Read a vote | – | Cast a vote | Delete a vote |
Per default the LoudVoice widget uses it's own authentication system. Users can simply login with their social network account, or enter their name and email address in order to post a new comment.
To seamlessly integrate LoudVoice into your website, you however probably do not want users to have to re-login into LoudVoice once they have logged in into your own website. This is where sessions come into play.
First create a new session with the desired user information and then
communicate the
corresponding author_session_token
to the LoudVoice widget.
Structure
Author session nodes have the format below. Absent values are returned as null
.
{ "author_session": { "author_session_token": "#author_session_token#", "date_creation": "#date_creation#", "date_last_update": "#date_last_update#", "date_expiration": "#date_expiration#", "expires_in": #expires_in#, "author": { #author# } } }
Node | Description |
---|---|
Identifiers | |
author_session_tokenuuid, automatically generated
|
Unique identifier of this author's session. Example: e570f17a-f018-49f2-be95-35dd31105c93 |
Session Metadata | |
date_creationstring, RFC 2822
|
On this date the session was created. Example: Tue, 13 Mar 2018 14:19:49 +0100 |
date_last_updatestring, RFC 2822
|
On this date the session was updated last. Example: Wed, 14 Mar 2018 18:19:49 +0100 |
date_expirationstring, RFC 2822
|
On this date the session will be invalidated and removed. Example: Wed, 14 Mar 2018 23:19:49 +0100 |
expires_ininteger
|
On each update the expiration date is incremented by this value. Example: 1209600 |
Author Metadata | |
authorJSON
|
Collection of data representing the author the session is for. |