This is an example on how to test this API and use it in your mobile/web applications.
\nWe will register a new account, sign in, create a few notes and update the newly created notes.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17031629","collectionId":"4635db3a-ac22-451f-94fb-04618d57469b","publishedId":"TzzDJv7Z","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-08-22T16:13:01.000Z"},"item":[{"name":"Signing Up using django-restauth package","id":"b16d38d5-0e86-40a1-a64c-f4de28ee7e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://notesrestapi.herokuapp.com/rest-auth/signup/","description":"We will send the username, email id and two passwords as the body to the mentioned url and in return we will receive a response as below.
\n","urlObject":{"protocol":"https","path":["rest-auth","signup",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"e0425566-c40a-4196-8ce6-ad68f21913a7","name":"Signing Up using django-restauth package","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"TestUser\",\r\n \"email\": \"testuser@email.com\",\r\n \"password1\": \"testuser123\",\r\n \"password2\": \"testuser123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://notesrestapi.herokuapp.com/rest-auth/registration/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 14:56:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"38"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"messages=W1siX19qc29uX21lc3NhZ2UiLDAsMjAsIkNvbmZpcm1hdGlvbiBlLW1haWwgc2VudCB0byB0ZXN0dXNlckBlbWFpbC5jb20uIl1d:1mHou7:UD9X-gOMYA5edCKwZE6B-GyUx4eD37KmdE8nn2nWbwI; HttpOnly; Path=/; SameSite=Lax"},{"key":"Set-Cookie","value":"sessionid=inrt8y881xdmv0fuok80dweakgngw2a1; expires=Sun, 05 Sep 2021 14:56:55 GMT; HttpOnly; Max-Age=1209600; Path=/; SameSite=Lax"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Verification e-mail sent.\"\n}"}],"_postman_id":"b16d38d5-0e86-40a1-a64c-f4de28ee7e25"},{"name":"Signing In after email-verification","id":"e766e620-e743-4361-a2a6-84d5d29f2c8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"TestUser\",\r\n \"password\": \"testuser123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://notesrestapi.herokuapp.com/rest-auth/login/","description":"We will receive a mail like this on our Gmail account.
\n\"Hello from Notes!
\nYou're receiving this e-mail because user TestUser has given your e-mail address to register an account on notes.com.
\nTo confirm this is correct, go to https://notesrestapi.herokuapp.com/accounts-rest/registration/account-confirm-email/NQ:1mHou6:00k0Uhj8l0Tq8ANGqrfIP3mQvwcXzSmZL1yyI6bubtk/
\nThank you for using Notes!\nnotes.com\"
\nAfter verifying our email address, we will login using our username and password.\nIn return we will receive a unique identification token generated for our unique account.
\n","urlObject":{"protocol":"https","path":["rest-auth","login",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"4d1e0cd7-79de-4b27-8e7f-d2bc2c795b42","name":"Signing In after email-verification","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"TestUser\",\r\n \"password\": \"testuser123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://notesrestapi.herokuapp.com/rest-auth/login/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:05:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"50"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"csrftoken=sTDlFJCBjVCedD3XxjbI1CrEDQiDwne4u0tq7z7hjp0XKt0z3I23uF6qWggdUIv6; expires=Sun, 21 Aug 2022 15:05:13 GMT; Max-Age=31449600; Path=/; SameSite=Lax"},{"key":"Set-Cookie","value":"sessionid=0mt28ixhneajvshmkouawt8d6uhtou2b; expires=Sun, 05 Sep 2021 15:05:13 GMT; HttpOnly; Max-Age=1209600; Path=/; SameSite=Lax"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"ac499d2f9ec41f0e13f50d4e85feda26182e2a33\"\n}"}],"_postman_id":"e766e620-e743-4361-a2a6-84d5d29f2c8b"},{"name":"Sending a GET request to recieve all the notes","id":"a83a2cc6-519d-4c34-b56a-904cd73a94a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","description":"TestUser Account
\n","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/","description":"Since we haven't created any notes up till now, we will see an empty array.
\nNote: We have used the identification token as a header in the format:
\n{'Authorization' : 'Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33'}
\nThis is done so that we are able to see the notes of only the signed in account.
\n","urlObject":{"protocol":"https","path":["api","v1","notes",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"3237ec71-1fc4-4e07-af0e-43bdf59e028f","name":"Sending a GET request to recieve all the notes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","description":"TestUser Account","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:12:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"2"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"a83a2cc6-519d-4c34-b56a-904cd73a94a7"},{"name":"Creating a new Note","id":"f725de3e-11ca-4e7d-a1ea-50a5f73ad981","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","description":"TestUser Account
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"title","value":"First Note by TestUser","type":"text"},{"key":"content","value":"This is the content for the first note and it also has an image. Cool na?","type":"text"},{"key":"image","type":"file","src":"/E:/Dehradun Trip Photos/IMG_20210730_160049.jpg"}]},"url":"https://notesrestapi.herokuapp.com/api/v1/notes/","description":"We will create a new note by sending a POST request to the same link, with the form data of title, content and image as the body and the token as the header.
\nMake sure to go to the image link. It is a snap from one of the spots that we visited in DehraDun. (PS: The image is saved on the AWS cloud.)
\n","urlObject":{"protocol":"https","path":["api","v1","notes",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"9187bb66-266c-4eed-a024-c29e2a5cbe53","name":"Creating a new Note","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","description":"TestUser Account","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"title","value":"First Note by TestUser","type":"text"},{"key":"content","value":"This is the content for the first note and it also has an image. Cool na?","type":"text"},{"key":"image","type":"file","src":"/E:/Dehradun Trip Photos/IMG_20210730_160049.jpg"}],"options":{"raw":{"language":"json"}}},"url":"https://notesrestapi.herokuapp.com/api/v1/notes/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:20:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"534"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"title\": \"First Note by TestUser\",\n \"content\": \"This is the content for the first note and it also has an image. Cool na?\",\n \"image\": \"https://notes-api-bucket-raghav.s3.amazonaws.com/api/IMG_20210730_160049.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4KYPRHERGKRAD5HW%2F20210822%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20210822T152024Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=3ddde11ad9b234a73ea89a4b9a1255eefd3579db8a4edab04333363dc24c0e78\",\n \"created\": \"2021-08-22, 20:50:24\",\n \"owner\": \"TestUser\"\n}"}],"_postman_id":"f725de3e-11ca-4e7d-a1ea-50a5f73ad981"},{"name":"Viewing all our notes","id":"53d55e7b-ca16-4333-98a9-d8bd4eda1640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/","description":"I created a few more notes for our TestUser using the django admin panel. Now we can access all those notes by just sending a GET request.
\nRemember, authorization token is always a must. Otherwise you will not be able to see any notes. You need to login.
\n","urlObject":{"protocol":"https","path":["api","v1","notes",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"64854cc2-72eb-42c2-a9f1-6e4fa32a0545","name":"Viewing all our notes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:30:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"926"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 2,\n \"title\": \"First Note by TestUser\",\n \"content\": \"This is the content for the first note and it also has an image. Cool na?\",\n \"image\": \"https://notes-api-bucket-raghav.s3.amazonaws.com/api/IMG_20210730_160049.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4KYPRHERGKRAD5HW%2F20210822%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20210822T153020Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=3a3edbeefe50995c749a1cdc867e1b012bd7b841edc6608c7deba1340cac925c\",\n \"created\": \"2021-08-22, 20:50:24\",\n \"owner\": \"TestUser\"\n },\n {\n \"id\": 3,\n \"title\": \"Shopping list\",\n \"content\": \"Milk, Bread, Eggs, and lots of Chips and Cold Drinks.\",\n \"image\": null,\n \"created\": \"2021-08-22, 20:56:19\",\n \"owner\": \"TestUser\"\n },\n {\n \"id\": 4,\n \"title\": \"Things to do today\",\n \"content\": \"Morning yoga, ESN-391 Assignment, Give a presentation, Meet the senior at Main Building, Have an awesome day!!\",\n \"image\": null,\n \"created\": \"2021-08-22, 21:00:16\",\n \"owner\": \"TestUser\"\n }\n]"}],"_postman_id":"53d55e7b-ca16-4333-98a9-d8bd4eda1640"},{"name":"Updating and deleting a specific note","id":"7204b825-6321-4bcb-983d-68065f1c4d35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Shopping list\",\r\n \"content\": \"Milk, Bread, Eggs, and lots of Chips and Cold Drinks. Bring some chocolates too!\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://notesrestapi.herokuapp.com/api/v1/notes/3/","description":"Want to update/delete a note? No problem, just enter the pk(primary key), or simply, the id of your note in the url and send a PUT/DELETE request.
\n","urlObject":{"protocol":"https","path":["api","v1","notes","3",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"26d715a2-0c82-4ed5-9301-ae37ab450be0","name":"Updating and deleting a specific note","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Token ac499d2f9ec41f0e13f50d4e85feda26182e2a33","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Shopping list\",\r\n \"content\": \"Milk, Bread, Eggs, and lots of Chips and Cold Drinks. Bring some chocolates too!\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://notesrestapi.herokuapp.com/api/v1/notes/3/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:34:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"190"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"title\": \"Shopping list\",\n \"content\": \"Milk, Bread, Eggs, and lots of Chips and Cold Drinks. Bring some chocolates too!\",\n \"image\": null,\n \"created\": \"2021-08-22, 21:04:49\",\n \"owner\": \"TestUser\"\n}"}],"_postman_id":"7204b825-6321-4bcb-983d-68065f1c4d35"},{"name":"Sending some unauthenticated requests","id":"bc59f3f5-b683-43f9-8ad4-4c5dff74780b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token eba6c09d9a96c84627e6905f787d4862b48dec3f","description":"RaghavIIT Account
\n","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/3/","description":"Now we will send a request to the same note of TestUser, but we will use a different authorization token in order to confirm that our permissions are working fine.
\n","urlObject":{"protocol":"https","path":["api","v1","notes","3",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"6995bff5-7ab2-4d5d-8555-f12a9138f249","name":"Sending some unauthenticated requests","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token eba6c09d9a96c84627e6905f787d4862b48dec3f","description":"RaghavIIT Account","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/3/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:48:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"bc59f3f5-b683-43f9-8ad4-4c5dff74780b"},{"name":"GETing the notes of a different user","id":"4d8bd237-1619-47fe-9eef-7bfd78620d84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token eba6c09d9a96c84627e6905f787d4862b48dec3f","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/","description":"Now let's get the notes of another user by just changing the authorization token in the header.
\n","urlObject":{"protocol":"https","path":["api","v1","notes",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"5bbda478-9166-4fd5-bf0c-155ddf5d393b","name":"GETing the notes of a different user","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token eba6c09d9a96c84627e6905f787d4862b48dec3f","type":"text"}],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:49:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"538"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"title\": \"Zoo Trip in Dehradun\",\n \"content\": \"This is a bird that we saw when we went to the zoo. It was beautiful\",\n \"image\": \"https://notes-api-bucket-raghav.s3.amazonaws.com/api/IMG_20210728_162025_OgYZpJe.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4KYPRHERGKRAD5HW%2F20210822%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20210822T154937Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=e735ef1baeccb209bcaf8cad93b6649f1f1c80a58a4ebcdb3c1d0f92c648c41f\",\n \"created\": \"2021-08-20, 17:07:54\",\n \"owner\": \"RaghavIIT\"\n }\n]"}],"_postman_id":"4d8bd237-1619-47fe-9eef-7bfd78620d84"},{"name":"Request without any authentication token","id":"cb35bb8a-1e2c-4e99-b9ae-f7a769a60a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/","description":"Sending no authentication token in the header means that you are logged out.
\n","urlObject":{"protocol":"https","path":["api","v1","notes",""],"host":["notesrestapi","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"50001a72-2995-4435-a3d8-cf037a8ce507","name":"Request without any authentication token","originalRequest":{"method":"GET","header":[],"url":"https://notesrestapi.herokuapp.com/api/v1/notes/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Sun, 22 Aug 2021 15:54:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Www-Authenticate","value":"Token"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"58"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"cb35bb8a-1e2c-4e99-b9ae-f7a769a60a70"}]}