Vzy API (Backend)
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"24154143","collectionId":"d170f094-c791-445f-adfe-0be7836efbe2","publishedId":"2sA2r55RxV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-14T22:04:30.000Z"},"item":[{"name":"Auth","item":[{"name":"Register","event":[{"listen":"test","script":{"id":"64a944d8-6eb7-4e3c-8983-a4193a85790b","exec":["pm.test(\"Response status code is 400\", function () {"," pm.response.to.have.status(400);","});","","pm.test(\"Response Content-Type is application/json\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");","});","","pm.test(\"Message field is an array and not empty\", function () {"," pm.expect(pm.response.json().message).to.be.an('array').and.to.have.lengthOf.at.least(1, \"Message field should not be empty\");","});","","pm.test(\"Error field must be a non-empty string\", function () {"," pm.expect(pm.response.json().error).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Error field should be a non-empty string\");","});","","pm.test(\"StatusCode should be a non-zero number\", function () {"," pm.expect(pm.response.json().statusCode).to.exist.and.to.be.a('number').and.to.not.equal(0);","});"],"type":"text/javascript"}}],"id":"88f7f3ff-0e5c-4186-ab71-2c2609a1ac71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"victor\",\n \"email\": \"victor@mailinator.com\",\n \"phoneNumber\": \"+2347088949042\",\n \"password\": \"Password123!\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://vzy-backend-8ycr.onrender.com/api/v1/auth/register","description":"This endpoint allows users to register with the application. Upon a successful registration, the server responds with a status code of 201 and a JSON object containing the registered user's details.
\nusername (string): The username of the user.email (string): The email address of the user.phoneNumber (string): The phone number of the user.password (string): The password for the user account.statusCode (number): Indicates the status of the response.data (object): Contains the registered user's details including username, email, phone number, password, user ID, creation and update timestamps, and version.message (string): Any additional message from the server.This endpoint allows users to authenticate and log in. The HTTP POST request should be sent to https://vzy-backend-8ycr.onrender.com/api/v1/auth/login with a raw request body containing the user's email and password.
\nUpon successful authentication, the endpoint returns a status code of 200 and a JSON response with the following structure:
\n{\n \"statusCode\": 0,\n \"data\": {\n \"user\": {\n \"_id\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"password\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n },\n \"token\": \"\"\n },\n \"message\": \"\"\n}\nThis endpoint makes an HTTP GET request to retrieve user information from the specified base URL. The response returns a status code of 200 along with a JSON object containing user data, including user ID, username, email, phone number, password, creation and update timestamps, and a version field. The message field is also included in the response.
\nAdd documentation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d170f094-c791-445f-adfe-0be7836efbe2","id":"d170f094-c791-445f-adfe-0be7836efbe2","name":"Vzy Backend","type":"collection"}},"urlObject":{"path":["user",""],"host":["https://vzy-backend-8ycr.onrender.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"14617544-ae2d-4713-9a0b-3a5a2a0991a9","name":"View Profile","originalRequest":{"method":"GET","header":[],"url":"https://vzy-backend-8ycr.onrender.com/api/v1/user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"546"},{"key":"ETag","value":"W/\"222-NKimcHBbcsuI0AdsgN5ECXv2w9M\""},{"key":"Date","value":"Wed, 14 Feb 2024 18:06:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": {\n \"_id\": \"65ccfe7e6e3b754b11db68cf\",\n \"username\": \"victor\",\n \"email\": \"victor@mailinator.com\",\n \"phoneNumber\": \"+2347088949042\",\n \"payments\": [\n {\n \"user\": \"65ccfe7e6e3b754b11db68cf\",\n \"stripeSessionId\": \"cs_test_a1rtlSPzjlmk33LtnHdYe6BsNrGJGtEfLNSxZlm2mYTMbqNTCvpcRF7doc\",\n \"amount\": 800,\n \"status\": \"succeeded\",\n \"_id\": \"65cd012cf903491509612540\",\n \"createdAt\": \"2024-02-14T18:06:36.320Z\",\n \"updatedAt\": \"2024-02-14T18:06:36.320Z\",\n \"__v\": 0\n }\n ],\n \"status\": \"paid\",\n \"createdAt\": \"2024-02-14T17:55:10.684Z\",\n \"updatedAt\": \"2024-02-14T18:06:36.625Z\"\n },\n \"message\": \"success\"\n}"}],"_postman_id":"770300d8-b774-4ee4-9dce-3e7e9a0a2913"},{"name":"Update Profile","event":[{"listen":"test","script":{"id":"671d6115-1acf-4801-9d7a-69aa5d3682dd","exec":["","pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"Email is in a valid format\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data.email).to.be.a('string').and.to.match(/^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$/);","});","",""],"type":"text/javascript"}}],"id":"85f13ffe-08ca-43fc-9059-02750efdd8c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"okoyevictor\"\n}","options":{"raw":{"language":"json"}}},"url":"https://vzy-backend-8ycr.onrender.com/api/v1/user/","description":"This endpoint allows you to update user information using an HTTP PATCH request to https://vzy-backend-8ycr.onrender.com/api/v1/user/.
\nThe request should include a raw JSON payload with the following parameters:
\nusername: (string) The new username for the user.phoneNumber: (string) The new phone number for the user.Upon successful execution, the endpoint returns a status code of 200 and a JSON response with the updated user data, including the user's ID, username, email, phone number, password, payment information, status, and timestamps.
\n{\n \"statusCode\": 0,\n \"data\": {\n \"_id\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"password\": \"\",\n \"payments\": [\n {\n \"user\": \"\",\n \"stripeSessionId\": \"\",\n \"amount\": 0,\n \"status\": \"\",\n \"_id\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n }\n ],\n \"status\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"__v\": 0\n },\n \"message\": \"\"\n}\n\nThis HTTP POST request is used to create a checkout session for payment. The response returns a status code of 201 and a JSON object with various attributes related to the checkout session. The attributes include details such as the session ID, amount, currency, customer details, payment status, and various configuration options for the checkout session.
\nExample response:
\n{\n \"id\": \"\",\n \"object\": \"\",\n \"after_expiration\": null,\n \"allow_promotion_codes\": null,\n \"amount_subtotal\": 0,\n \"amount_total\": 0,\n \"automatic_tax\": {\n \"enabled\": true,\n \"liability\": null,\n \"status\": null\n },\n \"billing_address_collection\": null,\n \"cancel_url\": \"\",\n \"client_reference_id\": null,\n \"client_secret\": null,\n ...\n // Other attributes\n ...\n \"ui_mode\": \"\",\n \"url\": \"\"\n}\nThis API request is used to initiate a checkout session and retrieve the details of the created session, including various configuration options and customer-related information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d170f094-c791-445f-adfe-0be7836efbe2","id":"d170f094-c791-445f-adfe-0be7836efbe2","name":"Vzy Backend","type":"collection"}},"urlObject":{"path":["payment","create-checkout-session"],"host":["https://vzy-backend-8ycr.onrender.com/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9f2102f7-b4f6-4da4-b3d2-585ea1e0950c","name":"Create Stripe Checkout Session","originalRequest":{"method":"POST","header":[],"url":"https://vzy-backend-8ycr.onrender.com/api/v1/payment/create-checkout-session"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2135"},{"key":"ETag","value":"W/\"857-B98RQtbMLFn2dD+9T7tGk3lhnlg\""},{"key":"Date","value":"Tue, 13 Feb 2024 20:38:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cs_test_a1JeKAkaDdDKvooUyoI1NTm1Qoj6ym00Pl8kvsU6JV2WPQQEItdTuhrOsI\",\n \"object\": \"checkout.session\",\n \"after_expiration\": null,\n \"allow_promotion_codes\": null,\n \"amount_subtotal\": 800,\n \"amount_total\": 800,\n \"automatic_tax\": {\n \"enabled\": false,\n \"liability\": null,\n \"status\": null\n },\n \"billing_address_collection\": null,\n \"cancel_url\": \"https://example.com/cancel\",\n \"client_reference_id\": null,\n \"client_secret\": null,\n \"consent\": null,\n \"consent_collection\": null,\n \"created\": 1707856718,\n \"currency\": \"usd\",\n \"currency_conversion\": null,\n \"custom_fields\": [],\n \"custom_text\": {\n \"after_submit\": null,\n \"shipping_address\": null,\n \"submit\": null,\n \"terms_of_service_acceptance\": null\n },\n \"customer\": null,\n \"customer_creation\": \"if_required\",\n \"customer_details\": {\n \"address\": null,\n \"email\": \"john52@example.com\",\n \"name\": null,\n \"phone\": null,\n \"tax_exempt\": \"none\",\n \"tax_ids\": null\n },\n \"customer_email\": \"john52@example.com\",\n \"expires_at\": 1707943117,\n \"invoice\": null,\n \"invoice_creation\": {\n \"enabled\": false,\n \"invoice_data\": {\n \"account_tax_ids\": null,\n \"custom_fields\": null,\n \"description\": null,\n \"footer\": null,\n \"issuer\": null,\n \"metadata\": {},\n \"rendering_options\": null\n }\n },\n \"livemode\": false,\n \"locale\": null,\n \"metadata\": {},\n \"mode\": \"payment\",\n \"payment_intent\": null,\n \"payment_link\": null,\n \"payment_method_collection\": \"if_required\",\n \"payment_method_configuration_details\": {\n \"id\": \"pmc_1NXtzrLucIOsd6AQm68ZjTyZ\",\n \"parent\": null\n },\n \"payment_method_options\": {},\n \"payment_method_types\": [\n \"card\",\n \"link\"\n ],\n \"payment_status\": \"unpaid\",\n \"phone_number_collection\": {\n \"enabled\": false\n },\n \"recovered_from\": null,\n \"setup_intent\": null,\n \"shipping_address_collection\": null,\n \"shipping_cost\": null,\n \"shipping_details\": null,\n \"shipping_options\": [],\n \"status\": \"open\",\n \"submit_type\": null,\n \"subscription\": null,\n \"success_url\": \"https://example.com/success\",\n \"total_details\": {\n \"amount_discount\": 0,\n \"amount_shipping\": 0,\n \"amount_tax\": 0\n },\n \"ui_mode\": \"hosted\",\n \"url\": \"https://checkout.stripe.com/c/pay/cs_test_a1JeKAkaDdDKvooUyoI1NTm1Qoj6ym00Pl8kvsU6JV2WPQQEItdTuhrOsI#fidkdWxOYHwnPyd1blpxYHZxWjA0S0ZOPTJJcGZMSnZhM0RUfExpNlV8Tk5LdEpMX0hjT3c3TGNWTW1yfXczSj1dSXIzdk11TUd1aU9TQUNXf3M3VHVwMlV%2FclJ8bE1wMFBNZEdIcWJSN09cNTVPcmFPTDUyXCcpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl\"\n}"}],"_postman_id":"11919201-b381-4adf-b29e-3dd530060e2c"}],"id":"1ceb1834-0022-40bd-be28-69a62aadfe15","_postman_id":"1ceb1834-0022-40bd-be28-69a62aadfe15","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d170f094-c791-445f-adfe-0be7836efbe2","id":"d170f094-c791-445f-adfe-0be7836efbe2","name":"Vzy Backend","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"9e86bc47-c98e-4122-ba3e-9e6da8fbdbf2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"829f76d6-6b77-4875-804e-eb85a65e2186","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseurl","value":"https://vzy-backend-8ycr.onrender.com/api/v1"},{"key":"jwtToken","value":""}]}