Authenticate User
Authenticate an author using their email address.
Only API keys on our Conversations platform are eligible to use this API version. Refer to the Platforms section of our Platform & API Concepts documentation to learn which platform your API keys are on.
Overview
Hosted email authentication can be used during submission to confirm the identity of a content submitter. When submitting content for the first time, a user receives an email containing a link. After clicking the link, the user is directed to a landing page that calls back to the API to confirm their identity. This call results in obtaining an encrypted user token that can be used in subsequent submission calls. Depending on the client's configuration, the content might not be accepted until the confirmation call is submitted.
Examples
The following examples demonstrate common Conversations API authentication requests. For a complete overview of authentication, refer to the Authentication tutorials.
Submitting a call to authenticate a user
https://[stg.]api.bazaarvoice.com/data/authenticateuser.[FORMAT]?ApiVersion=[latestApiVersion]&authtoken=[value]&PassKey=[yourKey]
Submission to authenticate a user must take the form of an HTTP POST.
Parameters
| Name | Description |
|---|---|
[FORMAT] | Response format (json).RequiredThis field is required in all API requests. |
ApiVersion | The API version, e.g. 5.4.RequiredThis field is required in all API requests. |
Authtoken | Value of the authentication token that was received in a user's authentication email. See the hostedauthentication_callbackurl parameter for more information.RequiredThis field is required in all API requests. |
PassKey | API key is required to authenticate API user and check permission to access particular client's data.RequiredThis field is required in all API requests. |
Response format
The following is an example of a response after submitting the form by HTTP POST:
{
"Data":{},
"HasErrors":false,
"Form":[],
"FormErrors":{},
"TypicalHoursToPost":null,
"SubmissionId":null,
"Locale":"en_US",
"Errors":[]
"Authentication":
{
"User":
"4d5a94aed5f29abd6bf9000c7518d3ee7573657269643d30313662626566642d343233632d346139332d396432342d65646666373161613065633526686f737465643d564552494649454426646174653d3230313230363132"
}
}
Response elements
| Name | Description |
|---|---|
Authentication | Section containing authentication data |
Data | Section containing all the data matched by a query grouped by content/subject type. Within each data section there is a map of objects keyed by ids |
Errors | Error section is populated instead of other fields if there is an error with a query syntax or problem executing a query. |
Form | Section containing an array of field and group references |
HasErrors | Boolean indicating if the response had errors or not |
Error codes
| Value | Description |
|---|---|
ERROR_BAD_REQUEST | Authentication token is invalid, missing or the user has already been authenticated |
Updated 9 months ago