Besides a full iFrame integration, it is possible to perform an integration via API and JSON feed.
This integration requires more effort on your part, because the question, public answer, and reporting forms are to be created on your end.
For the time being, the discussion and community-answer forms are created by the Q&A team.
The advantage of this integration method is that it gives you greater control of the Q&A tool.
The Q&A API allows you to do four things:
- Ask a question
- Provide a public answer
- Report an answer
- Vote for a question or answer
Community answers are submitted via a link in the email sent out to the community. The same applies for discussions. Online API documentation is available here.
All API calls should use POST. All API returns are in JSON.
You must include the following text in your question, public answer and report creation forms: “I accept the Verified Reviews<a href="https://www.netreviews.com/en/consumer-terms-service/" target="_blank" style='font-weight: bold’>terms & conditions</a> and the Verified Reviews <a href="https://www.netreviews.com/en/privacy-policy/" target="_blank" style='font-weight: bold’>privacy policy</a>."
Asking a question
{{idWebsite}}: your Verified Reviews user ID (required)
{{productId}}: the identifier of the current page’s product (required)
{{token}}: a sha1 hash of your website identifier and your secret key (required)
{{query}}: action the API must perform; here this parameter’s value is “addQuestion” (required)
{{firstName}}: first name or pseudonym of the person who asked the question (required)
{{lastName}}: last name of the person who asked the question
{{email}}: email address of the person who asked the question (required)
{{category}}: enables you to assign a category to the question
{{productPage}}: enables you to save the product page so that it is available through the back office
{{title}}: title of the question (required)
{{question}}: content of the question (required)
{{gcuCheck}}: acceptance of our T&C and privacy policy. Accepted values: true/false (boolean) (required).
URL: //qr.netreviews.eu/apiForm.php
Returns:
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
The error code varies according to the type of error. For example, with a parameter error the code will be “0X0000003”. {{ERROR MESSAGE}} also depends on the error type. Using the same example, the message will be: “INVALID PARAMETERS”.
If successful, the user will receive an email to confirm their email address. This is a required step in order for the elements to be available in the back office.
Providing a public answer
{{idWebsite}}: your Verified Reviews user ID (required)
{{token}}: a sha1 hash of your website identifier and your secret key (required)
{{query}}: action the API must perform; here this parameter’s value is “addPublicAnswer” (required)
{{firstName}}: first name or pseudonym of the person who submitted the answer (required)
{{lastName}}: last name of the person who submitted the answer
{{email}}: email address of the person who submitted the answer (required)
{{uuid}}: the question’s UUID (required)
{{text}}: answer content (required)
{{gcuCheck}}: acceptance of our T&C and privacy policy. Accepted values: true/false (boolean) (required).
URL: //qr.netreviews.eu/apiForm.php
Returns:
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
The error code varies according to the type of error. For example, with a parameter error the code will be “0X0000003”. {{ERROR MESSAGE}} also depends on the error type. Using the same example, the message will be: “INVALID PARAMETERS”.
If successful, the user will receive an email to confirm their email address. This is a required step in order for the elements to be available in the back office.
Reporting an answer
{{idWebsite}}: your Verified Reviews user ID (required)
{{token}}: a sha1 hash of your website identifier and your secret key (required)
{{query}}: action the API must perform; here this parameter’s value is “addReport” (required)
{{firstName}}: first name or pseudonym of the person who submitted the report (required)
{{lastName}}: last name of the person who submitted the report
{{email}}: email address of the person who submitted the report (required)
{{uuid}}: UUID of the item being reported (required)
{{text}}: answer content (required)
{{gcuCheck}}: acceptance of our T&C and privacy policy. Accepted values: true/false (boolean) (required).
URL: //qr.netreviews.eu/apiForm.php
Returns:
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
The error code varies according to the type of error. For example, with a parameter error the code will be “0X0000003”. {{ERROR MESSAGE}} also depends on the error type. Using the same example, the message will be: “INVALID PARAMETERS”.
If successful, the user will receive an email to confirm their email address. This is a required step in order for the elements to be available in the back office.
Voting for a question/answer
{{idWebsite}}: your Verified Reviews user ID (required)
{{token}}: a sha1 hash of your website identifier and your secret key (required)
{{query}}: action the API must perform; here this parameter’s value is “vote” (required)
{{uuid}}: UUID of the question/answer for which the user is voting (required)
{{type}}: positive or negative vote for the question/answer. The value can only be “up” or “down” (required)
{{type}}: positive or negative vote for the question/answer. The value can only be “up” or “down” (required)
URL: //qr.netreviews.eu/apiForm.php
Returns:
{success: true, code: "0X0000000", message: "success"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
{success: true, code: "0X0000000", message: "already_voted"}
The error code varies according to the type of error. For example, with a parameter error the code will be “0X0000003”. {{ERROR MESSAGE}} also depends on the error type. Using the same example, the message will be: “INVALID PARAMETERS”.
A user may only vote once per question/answer, which is why the API may return the message “already_voted”, indicating that the vote has already been taken into account.