This API(identifiable as Restaurant API in the meantime) will serve as an online collection of restaurants, for existing or newly created online and onsite restaurants, providing them another platform for sales.
\nIt is a mobile food vendor to customer services. Food vendors will place food items they have on their profile, with cost price(including delivery), customers will scan through, find what they want and place orders. Payments will be made to the platform, vendors can withdraw from their account at anytime.
\nEndpoints for this API is exposes in this documentation, with instructions and examples of requests and expected responses.
\nAuthentication: This API uses JWT authentication, and some of its endpoint requires a valid JWT to be supplied in the request header.
\nConfiguration: This collection requires several predefined environment variable, which are listed below. You will need to add them to your own environment when testing with Postman
\nurl: The root url. The default value should be 127.0.0.1:5000access_token: JWT used for login. It will be set automatically by some of the request test scripts.refresh_token: Used for refreshing a JWT. It will be set automatically by some of the request test scripts.
Note:
* Content-Type should be set to multipart/form-data\n* File should be sent with \"image\" key\n* Authorization header should be set to Bearer {access_token}\n* The only allowed extensions include
'.jpg', '.jpe', '.jpeg', '.png', '.gif', '.svg', '.bmp'
Note:
* Authorization header must be set to `Bearer access_token}
\n","urlObject":{"path":["vendor","logo","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6bfa8e65-5c17-455b-b5ef-aadb4a08a59e","name":"Get a Logo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{url}}/vendor/logo/5"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"43caa9a2-b102-4222-b4d0-6a55e327d50f","name":"Image not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{url}}/vendor/logo/50"},"status":"NOT FOUND","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.2 Python/3.10.4"},{"key":"Date","value":"Tue, 11 Oct 2022 02:45:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"37"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Image not found\"\n}"}],"_postman_id":"79955204-f7d2-48b5-a2cc-44516c81da3f"},{"name":"Delete a Logo","id":"ac6bd8fa-caad-44f2-b78f-a09fed922aa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{url}}/vendor/logo/1","description":"Note:
* Authorization header must be set to Bearer {access_token}\n* Privilege for this operation will only be for owner of the account
Note:
* Duplicate Email not allowed
* Invalid email will return a 500
Note:
* Email must already exist(must have already registered email)
* Will only process request for un-validated email accounts
* Email must be passed in URL
Note:
* Duplicate Restaurant name not allowed
* Confirmation ID expires in 30 minutes
* Confirmation ID can only be used once
Notes:
* Account must be created and validated before login\n* Access token expires after 15 minutes after which refresh token should be requested
\n","urlObject":{"path":["vendor","login"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6cedcf81-43db-489d-8650-fe2b3ed2599e","name":"Vendor Login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"oduazubike@gmail.com\",\n \"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/vendor/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.2 Python/3.10.4"},{"key":"Date","value":"Mon, 10 Oct 2022 12:25:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"575"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6dHJ1ZSwiaWF0IjoxNjY1NDA0NzE4LCJqdGkiOiI4MzMyOGRmMi03ODEzLTQxZjItOTY1MS1kMTYzNGY0ZDhjMjkiLCJ0eXBlIjoiYWNjZXNzIiwic3ViIjoxLCJuYmYiOjE2NjU0MDQ3MTgsImV4cCI6MTY2NTQwNTYxOH0.XtQyceYy8sePJa-xzEhs26W2tKirsqU_1Mr8ZOHnFGk\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTY2NTQwNDcxOCwianRpIjoiOTkyMjEzMjMtZGFhOS00YmM0LTg4OGYtZDg0NDc2NzJiMGExIiwidHlwZSI6InJlZnJlc2giLCJzdWIiOjEsIm5iZiI6MTY2NTQwNDcxOCwiZXhwIjoxNjY3OTk2NzE4fQ.rupF5egys3i6Z7c2VJtC57khd2k6g-Xs49cD4YKCM1s\"\n}"},{"id":"575d1fd6-0a10-45ff-a08e-e351aa50840e","name":"Incorrect email/passowrd supplied","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"oduazubike@gmail.com\",\n \"password\": \"passord\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/vendor/login"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.2 Python/3.10.4"},{"key":"Date","value":"Mon, 10 Oct 2022 12:35:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Invalid credentials supplied\"\n}"},{"id":"9daf51f5-70f0-4227-aeed-cca6800cf789","name":"Unvalidated or unregistered account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"zubic@gmail.com\",\n \"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/vendor/login"},"status":"BAD REQUEST","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.2 Python/3.10.4"},{"key":"Date","value":"Mon, 10 Oct 2022 12:39:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"110"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Account not validated yet! Check email and proceed to complete Registration before login\"\n}"}],"_postman_id":"34f42716-bae7-4d94-a609-45e81d0e6966"},{"name":"Token Refrehing","event":[{"listen":"test","script":{"id":"7162b221-d7cc-4ae4-a317-ab7951309e90","exec":["var jsonData = pm.response.json();","pm.test(\"access_token not empty\", function () {"," pm.expect(jsonData.access_token).not.eql(undefined);","});","// set access token as environement variable","if (jsonData.access_token !== undefined) {"," postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);","} else {"," postman.setEnvironmentVariable(\"access_token\", null);","}"],"type":"text/javascript"}}],"id":"144abc81-5cd9-4993-8316-c0962e1a6434","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{refresh_token}}","type":"text"}],"url":"{{url}}//vendor/refresh","description":"Note:
* Requires Authorization header, set to Bearer {refresh_token}\n* Must be logged in before making this request\n* Must send a valid JWT token
Note:
* Password of logged in vendor must be correct.
* Authorization header must be set to Bearer {refresh_token}
Note:
* Authorization header must be set to Bearer {access_token}\n* Token must be fresh\n* Operation privilege limited to owner of the account
Note:
Bearer {access_token}Note:
Bearer {access_token}Note:
* Token expires after 5 minutes
\n","urlObject":{"path":["vendor","reset","eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTY2NTQzNTc5NSwianRpIjoiMTNlYTc2NTUtY2YwOC00MWVmLWI0MDQtZDgzZTg1ZjBkZjY4IiwidHlwZSI6ImFjY2VzcyIsInN1YiI6NSwibmJmIjoxNjY1NDM1Nzk1LCJleHAiOjE2NjU0MzYwOTV9.EQX__SYN358KE6wjiFyyjFnvrSnUCLeqqTKNW-ZtOM8"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cf00c7be-6403-4d61-8d42-28f370c1a2c3","name":"Reset Password","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"pass\"\n}"},"url":"{{url}}/vendor/reset/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTY2NTQzNTc5NSwianRpIjoiMTNlYTc2NTUtY2YwOC00MWVmLWI0MDQtZDgzZTg1ZjBkZjY4IiwidHlwZSI6ImFjY2VzcyIsInN1YiI6NSwibmJmIjoxNjY1NDM1Nzk1LCJleHAiOjE2NjU0MzYwOTV9.EQX__SYN358KE6wjiFyyjFnvrSnUCLeqqTKNW-ZtOM8"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.2 Python/3.10.4"},{"key":"Date","value":"Mon, 10 Oct 2022 21:04:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"103"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Your Password Reset was successful! You will need to login with your new password\"\n}"},{"id":"883fe033-3e4b-468a-acbd-e763291ac068","name":"Expired token","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"password\"\n}"},"url":"{{url}}/vendor/reset/eyJ0eXAiOiJKV1QiLCJhbGciOiJeUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTY2NTQzNDY0MCwianRpIjoiM2U3Y2FkNmEtNGQzMS00YmU5LTg2NTAtN2NjNTQ3ODRhNGUwIiwidHlwZSI6ImFjY2VzcyIsInN1YiI6NSwibmJmIjoxNjY1NDM0NjQwLCJleHAiOjE2NjU0MzQ5NDB9.uARd6RMiBK0wpVtk8JHYA36o5aVCsb0vMgcQLay265Q"},"status":"UNAUTHORIZED","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Werkzeug/2.2.2 Python/3.10.4"},{"key":"Date","value":"Mon, 10 Oct 2022 20:59:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Description\": \"Your token has expired\",\n \"Error\": \"token expired\"\n}"}],"_postman_id":"2e2ab25c-547d-402b-b76a-bf587cd40715"},{"name":"Change Password","id":"76576b87-5a95-43bf-869c-1872e5cbd680","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"password\": \"password\",\n \"new_password\": \"password\"\n}"},"url":"{{url}}/vendor/change_password","description":"Note:
* Authorization header must be set to Bearer {access_token}
* Token must be fresh
Note:
* Must be logged in\n* Authorization header must be set to Bearer {access_token}
Note:
* Must be logged in\n* Authorization header must be set to Bearer {refresh_token}