{"document":{"Id":3,"PageName":"Authentication","PageSlug":"Authentication","MetaTitle":"Authentication API Documentation Guide","MetaDescription":"Explore the Authentication API with clear steps on securing and managing user data.","documentList":null},"documentdata":"
\n
\n

Authentication<\/h3>\n

<p><span style="color: rgb(14, 16, 26); background-color: transparent;">The Quick Moderate API uses OAuth 2.0 which requires more authentication processes like passing two header keys in the <\/span><a href="https:\/\/admin.quickmoderate.com\/login" rel="noopener noreferrer" target="_blank" style="color: rgb(0, 102, 204); background-color: transparent;">Dashboard<\/a><span style="color: rgb(0, 102, 204);"> <\/span><span style="color: rgb(14, 16, 26); background-color: transparent;">of the API.<\/span> <span style="color: rgb(14, 16, 26); background-color: transparent;">One key is named<\/span><span style="color: rgb(102, 163, 224);"> AppKey<\/span> &amp; <span style="color: rgb(14, 16, 26); background-color: transparent;">the other is<\/span> <span style="color: rgb(102, 163, 224);">UserKey <\/span><span style="color: rgb(14, 16, 26); background-color: transparent;">at the time of calling the API; it's a two-step auth required as mentioned<\/span>.<\/p><p><br><\/p><p><span style="color: rgb(14, 16, 26); background-color: transparent;">It starts with the authentication of the required keys then the API hits to get the Auth Token which is an additional step of authentication for the entire API calls. It will require your API keys then it will return the Authentication token generated for the time duration of 5 minutes. Then the token will expire. This is an additional security feature that consists of the API.<\/span><\/p><p><br><\/p><p><span style="color: rgb(53, 58, 68);">All API requests must be made over <\/span><a href="https:\/\/en.wikipedia.org\/wiki\/HTTPS" rel="noopener noreferrer" target="_blank" style="color: rgb(0, 102, 204);">HTTPS<\/a><span style="color: rgb(53, 58, 68);">. Calls made over plain HTTP will fail. API requests without authentication will also fail.<\/span><\/p><\/p>\n\n <\/div>\n\n

\n
\n
\n Authenticated Request<\/span>\n
\n \"Copy\"\n <\/div>\n <\/div>\n
\n
<pre class="ql-syntax" spellcheck="false">curl -X 'POST' \\\n 'https:\/\/sandbox.quickmoderate.com\/api\/GenerateAuthToken' \\\n -H 'accept: *\/*' \\\n -H 'X-App-Key: Your App Key' \\\n -H 'X-User-Key: Your User Key' \\\n -d ''\n\n\n\n<\/pre><\/div>\n <\/div>\n <\/div>\n
\n
\n Your API Key<\/span>\n <\/div>\n
\n
<p>A sample test API key is included in all the examples here, so you can test any example right away. Do not submit any personally identifiable information in requests made with this key.<\/p><p><br><\/p><p>To test requests using your account, replace the sample API key with your actual API key or&nbsp;sign in.<\/p><\/div>\n <\/div>\n <\/div>\n \n <\/div>\n <\/div>\n
\n
\n
\n

Connected Accounts<\/h3>\n

<p>To connect your account as connected account one should use there <span style="color: rgb(102, 163, 224);">Quick Moderate-Account<\/span> in the header section. By connecting your account make sure that the connected account contains the <span style="color: rgb(102, 163, 224);">Quick Moderate<\/span> prefix as the starting of the prefix.<\/p><p><br><\/p><p><span style="color: rgb(53, 58, 68);">The value is set per-request as shown in the adjacent code sample. Methods on the returned object reuse the same account ID.<\/span><\/p><\/p>\n\n <\/div>\n\n

\n
\n
\n PER-REQUEST ACCOUNT<\/span>\n
\n \"Copy\"\n <\/div>\n <\/div>\n
\n
<pre class="ql-syntax" spellcheck="false">curl -X 'POST' \\\n 'https:\/\/sandbox.quickmoderate.com\/api\/GenerateAuthToken' \\\n -H 'accept: *\/*' \\\n -H 'X-App-Key: Your App Key' \\\n -H 'X-User-Key: Your User Key' \\\n -d ''\n<\/pre><\/div>\n <\/div>\n <\/div>\n \n <\/div>\n <\/div>\n "}