These API endpoints allow registered API users to access data from the Vie d'Elegance web application. The products offered are:
\nTo access this data an API key and in some cases an API token must be provided. API keys are permanent unless updated or revoked by the API user or the admin. API tokens expire within an hour of their creation after which a new token must be generated.
\nAPI users can access their portal, where they can register for these products and generate new keys and tokens, using their username and API key. The URL to access the portal is as shown below:
\n/api/[username]?key=[API key]
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16312077","collectionId":"e9bab6d7-e67d-456b-9f35-7ab3edb784cd","publishedId":"UVeCQoDT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-30T07:31:54.000Z"},"item":[{"name":"Users","item":[{"name":"AllUserDetails","id":"78de7e6f-7b96-475f-a973-3c1807fec71f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156","description":"To get all users' details. Ordered by most recently joined by default. To sort, add a segment. Some available options are latest_active, gender and last_login.
\nURL format: /api/users/{sort by}?[query params]
\n","urlObject":{"port":"8080","path":["api","users"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"}],"variable":[]}},"response":[],"_postman_id":"78de7e6f-7b96-475f-a973-3c1807fec71f"},{"name":"UsersByLastPurchase","id":"60859540-9d9f-4622-95bb-779463d40216","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users/latest_active?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156","description":"To get users sorted by last purchase
\nURL format: /api/users/latest_active?[query params]
\n","urlObject":{"port":"8080","path":["api","users","latest_active"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"}],"variable":[]}},"response":[],"_postman_id":"60859540-9d9f-4622-95bb-779463d40216"},{"name":"UsersByGender","id":"8a41b6f1-f6ae-4d65-b6bb-541cf0b79a16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users/gender?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156","description":"To get users sorted by gender
\nURL format: /api/users/gender?[query params]
\n","urlObject":{"port":"8080","path":["api","users","gender"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"}],"variable":[]}},"response":[],"_postman_id":"8a41b6f1-f6ae-4d65-b6bb-541cf0b79a16"},{"name":"UsersByLastLogin","id":"491af0d8-73ec-40fb-93d3-65c3d28bc1b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users/last_login?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156","description":"To get users sorted by last login time
\nURL format: /api/users/last_login?[query params]
\n","urlObject":{"port":"8080","path":["api","users","last_login"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"}],"variable":[]}},"response":[],"_postman_id":"491af0d8-73ec-40fb-93d3-65c3d28bc1b1"},{"name":"UsersWithSpecificItem","id":"a327dbbb-9f41-4ff9-a78c-72451290009c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156&productid=15","description":"To get users who bought a specific product by product ID
\nURL format: /api/users/{sort by}?[query params]&productid=[product ID]
\n","urlObject":{"port":"8080","path":["api","users"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"},{"description":{"content":"Product ID searched
\n","type":"text/plain"},"key":"productid","value":"15"}],"variable":[]}},"response":[],"_postman_id":"a327dbbb-9f41-4ff9-a78c-72451290009c"},{"name":"UsersWithSpecificCategory","id":"dc6c6a41-b3c1-42fc-bbdd-9b0b8fc749c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156&category=1","description":"To get users who bought from a category by category ID
\nURL format: /api/users/{sort by}?[query params]&category=[category ID]
\n","urlObject":{"port":"8080","path":["api","users"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"},{"description":{"content":"Category ID searched
\n","type":"text/plain"},"key":"category","value":"1"}],"variable":[]}},"response":[],"_postman_id":"dc6c6a41-b3c1-42fc-bbdd-9b0b8fc749c4"},{"name":"UsersWithSpecificDatePurchased","id":"1713a785-0a04-45a4-a3f3-b9030e545979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156&datepurchased=2021-12-26","description":"To get users who made orders on a specific date.
\nURL format: /api/users/{sort by}?[query params]&datepurchased=[YYYY-MM-DD]
\n","urlObject":{"port":"8080","path":["api","users"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"},{"description":{"content":"Date of purchase
\n","type":"text/plain"},"key":"datepurchased","value":"2021-12-26"}],"variable":[]}},"response":[],"_postman_id":"1713a785-0a04-45a4-a3f3-b9030e545979"},{"name":"SingleUserDetails","id":"1f0d2e3d-89dc-4440-bd15-abea5eab91de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/users/1?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=c519bf8baed091cd1fbf728b2f589156","description":"To get a single users' details by their user ID.
\nURL format: /api/users/[user ID]?[query params]
\n","urlObject":{"port":"8080","path":["api","users","1"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"c519bf8baed091cd1fbf728b2f589156"}],"variable":[]}},"response":[],"_postman_id":"1f0d2e3d-89dc-4440-bd15-abea5eab91de"}],"id":"c5c1a7b2-6063-4e5d-8944-b41d154cb88e","description":"Required query parameters:
\nInsecure endpoint to get all products' details. Ordered by most recently added by default. To sort, add a segment.
\nURL format: /api/products/{sort by}?[query params]
\n","urlObject":{"port":"8080","path":["api","products"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"}],"variable":[]}},"response":[],"_postman_id":"05d70cd0-a541-4100-a4b0-53d732c48772"},{"name":"SingleProductDetails","id":"93713cf1-06c9-4f10-8ef7-022afb7a900c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/products/14?uname=apiuser","description":"Insecure endpoint to get a single product's details.
\nURL format: /api/products/[product ID]?[query params]
\n","urlObject":{"port":"8080","path":["api","products","14"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"}],"variable":[]}},"response":[],"_postman_id":"93713cf1-06c9-4f10-8ef7-022afb7a900c"},{"name":"ProductsByUser","id":"0579148b-3be8-4580-a017-63f6472f463c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/products?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=4c21ab1e115e44f3f6e75a8dad7580ea&userid=1","description":"Secure endpoint to get products bought by a user.
\nURL format: /api/products/{sort by}?[query params]&userid=[user ID]
\n","urlObject":{"port":"8080","path":["api","products"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"4c21ab1e115e44f3f6e75a8dad7580ea"},{"description":{"content":"User ID searched
\n","type":"text/plain"},"key":"userid","value":"1"}],"variable":[]}},"response":[],"_postman_id":"0579148b-3be8-4580-a017-63f6472f463c"},{"name":"ProductsByCategory","id":"c6acb927-09cf-44a9-a355-e1dc923eb68e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/products?uname=apiuser&category=1","description":"Insecure endpoint to get products in a specific category.
\nURL format: /api/products/{sort by}?[query params]&category=[category ID]
\n","urlObject":{"port":"8080","path":["api","products"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"Category ID searched
\n","type":"text/plain"},"key":"category","value":"1"}],"variable":[]}},"response":[],"_postman_id":"c6acb927-09cf-44a9-a355-e1dc923eb68e"},{"name":"ProductsByNameSearch","id":"3dc61f5f-bf5c-4666-a295-1b4e90b1bef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/products?uname=apiuser&namesearch=red","description":"Insecure endpoint to get products by name in a wild card search.
\nURL format: /api/products?[query params]&namesearch=[search string]
\n","urlObject":{"port":"8080","path":["api","products"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"Searched string
\n","type":"text/plain"},"key":"namesearch","value":"red"}],"variable":[]}},"response":[],"_postman_id":"3dc61f5f-bf5c-4666-a295-1b4e90b1bef0"},{"name":"ProductsBySalesVolume","id":"42a69dc1-6eb1-4778-8df7-0baed9408607","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/products/sales?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=4c21ab1e115e44f3f6e75a8dad7580ea","description":"Secure endpoint to get products ordered by sales volume.
\nURL format: /api/products/sales?[query params]
\n","urlObject":{"port":"8080","path":["api","products","sales"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"4c21ab1e115e44f3f6e75a8dad7580ea"}],"variable":[]}},"response":[],"_postman_id":"42a69dc1-6eb1-4778-8df7-0baed9408607"}],"id":"74071cb0-1629-4198-88ee-9be1f02a9eab","description":"Required query parameters:
\nTo get all transaction details. Ordered by most recent transactions by default. To sort, add a segment.
\nURL format: /api/transactions/{sort by}?[query params]
\n","urlObject":{"port":"8080","path":["api","transactions"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"74d8c5d46ebc341dd7d6facf17d75e5a"}],"variable":[]}},"response":[],"_postman_id":"09e74ac8-9cc5-4732-8ebb-7af135377132"},{"name":"TransactionDetailsByDateRange","id":"049daac8-c004-449d-8ddc-919aab58b49f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/transactions?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=74d8c5d46ebc341dd7d6facf17d75e5a&daterange=2022-01-21+2022-01-30","description":"To get all transaction details filtered by a rangle of dates from the eariler date to the later date in the format YYYY-MM-DD separated by a whitespace or a '+'.
\nURL format: /api/transactions/{sort by}?[query params]&daterange=[YYYY-MM-DD+YYYY-MM-DD]
\n","urlObject":{"port":"8080","path":["api","transactions"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"74d8c5d46ebc341dd7d6facf17d75e5a"},{"description":{"content":"Range of dates
\n","type":"text/plain"},"key":"daterange","value":"2022-01-21+2022-01-30"}],"variable":[]}},"response":[],"_postman_id":"049daac8-c004-449d-8ddc-919aab58b49f"},{"name":"TransactionDetailsByCategory","id":"8d19ecf6-4f40-4240-a3f0-8cab9ef226b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/transactions?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=74d8c5d46ebc341dd7d6facf17d75e5a&category=2","description":"To get all transaction details filtered by category ID
\nURL format: /api/transactions/{sort by}?[query params]&category=[category ID]
\n","urlObject":{"port":"8080","path":["api","transactions"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"74d8c5d46ebc341dd7d6facf17d75e5a"},{"description":{"content":"Category ID searched
\n","type":"text/plain"},"key":"category","value":"2"}],"variable":[]}},"response":[],"_postman_id":"8d19ecf6-4f40-4240-a3f0-8cab9ef226b6"},{"name":"TransactionDetailsByProduct","id":"97caede8-f9ba-4ce2-9686-9af65baa0238","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/transactions?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=74d8c5d46ebc341dd7d6facf17d75e5a&productid=15","description":"To get all transaction details filtered by product ID
\nURL format: /api/transactions/{sort by}?[query params]&productid=[product ID]
\n","urlObject":{"port":"8080","path":["api","transactions"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"74d8c5d46ebc341dd7d6facf17d75e5a"},{"description":{"content":"Product ID searched
\n","type":"text/plain"},"key":"productid","value":"15"}],"variable":[]}},"response":[],"_postman_id":"97caede8-f9ba-4ce2-9686-9af65baa0238"},{"name":"TransactionDetailsBySubcategory","id":"7706305c-e683-4312-8cb7-1214b6f88a86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/transactions?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=74d8c5d46ebc341dd7d6facf17d75e5a&subcategory=2","description":"To get all transaction details filtered by subcategory ID
\nURL format: /api/transactions/{sort by}?[query params]&subcategory=[subcategory ID]
\n","urlObject":{"port":"8080","path":["api","transactions"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API tsuoken
\n","type":"text/plain"},"key":"token","value":"74d8c5d46ebc341dd7d6facf17d75e5a"},{"description":{"content":"Subcategory ID searched
\n","type":"text/plain"},"key":"subcategory","value":"2"}],"variable":[]}},"response":[],"_postman_id":"7706305c-e683-4312-8cb7-1214b6f88a86"},{"name":"SingleTransactionDetails","id":"8401a689-2ce8-4608-a886-179826dbee60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8080/api/transactions/10?uname=apiuser&key=123fcfd35dd8a1457e734ee0a1973ecd6fae2794&token=74d8c5d46ebc341dd7d6facf17d75e5a","description":"To get a single transaction's details.
\nURL format: /api/transactions/[order ID]?[query params]
\n","urlObject":{"port":"8080","path":["api","transactions","10"],"host":["localhost"],"query":[{"description":{"content":"Username
\n","type":"text/plain"},"key":"uname","value":"apiuser"},{"description":{"content":"API key
\n","type":"text/plain"},"key":"key","value":"123fcfd35dd8a1457e734ee0a1973ecd6fae2794"},{"description":{"content":"API token
\n","type":"text/plain"},"key":"token","value":"74d8c5d46ebc341dd7d6facf17d75e5a"}],"variable":[]}},"response":[],"_postman_id":"8401a689-2ce8-4608-a886-179826dbee60"}],"id":"3dca2271-2b38-4785-b8f3-be0ea7de9675","description":"Required query parameters:
\n