Testing
Test with a Postman collection Use the Postman collection to try out the Viva City API. The collection includes the relevant types of requests for each endpoint, including create, read, update, and delete. Getting started with the Postman collection 1. Import the Viva City Collection to your local copy of Postman. 2. Add the credentials as the values for the corresponding Postman environment…
170 subscribers
0.1/10 popularity
383 ms avg latency
50 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Testing endpoints
| Method | Endpoint | Description |
|---|---|---|
| Menu App | ||
| GET |
WechatUserInfo /test/instore/wechat/getUserInformation |
Get Wechat user profile information using code or token provided from the Wechat backend/system upon scanning QR Code from Wechat app. > **NOTE**: > - Authentication… |
| POST |
AlgoliaSearch /search |
This will search for the nearby restaurants based on the given geo search filter and sort results by distance around certain geographical location. Json Parameters Name… |
| GET |
VenueDetail /venue-i18n/venues/{id}/details |
A **multi-language** api Get venue details using KV (need resync to get latest data) and filter dynamic multi language data based on query params (eg. ?lang=zh-hans) |
| GET |
MenuDetail /venue-i18n/menus/{id}/details |
A **multi-language** api Get menu details using KV (need resync to get latest data) and filter dynamic multi language data based on query params (eg. ?lang=zh-hans) |
| GET |
MenuOrder /test/instore/menu_order |
This api is still on progress Get information about the order from the menu. |
| GET |
B2BOrganisationdetails /b2b/organizations/{org_id} |
This endpoint will retrieve a specific organisation details with city list assigned. |
| GET |
VenueRecommendation /test/instore/v1/venue/{id}/recommendations |
This will return all the recommended dishes for the venue with their food names & details , meals by category, drinks and promotions. |
| Authentication | ||
| GET |
UserConfirmInvitation /ms-securities/api/auth/confirm-invite/{key} |
Once the user completed the signup form the key will no longer be valid and this will return an error of ```400 Bad Request``` with the following JSON response. { "error": "bad… |
| GET |
ConfirmChangeofPassword /ms-securities/api/auth/confirm-forgot-password |
|
| POST |
UserInvite /ms-securities/api/auth/user-invite |
Adding a user to an **organisation**. When success this will send an invitation with activation link to the email provided. *View in frontend*… |
| POST |
AccountUserInvite /ms-securities/api/auth/account-user-invite |
Adding a user to portal. When success this will send an invitation with activation link to the email provided. *View in frontend*… |
| GET |
ValidateEmail /ms-securities/api/auth/validate-email |
When inviting a user this will first validate if the email input is valid and is not yet taken. Email must be unique. |
| POST |
UserCompleteSignUp /ms-securities/api/auth/confirm-invite/{key} |
Once the user completed the signup form the key will no longer be valid and this will return an error of ```400 Bad Request``` with the following JSON response. { "error": "bad… |
| GET |
AccountUserConfirmInvitation /test/selfservice/confirm-account-user-invite/{key} |
|
| POST |
AccountUserCompleteSignUp /test/selfservice/confirm-account-user-invite/{key} |
Proceed with completing the signup |
| POST |
CompleteChangeofPassword /ms-securities/api/auth/confirm-forgot-password |
|
| POST |
Login /ms-securities/api/auth/login |
Used for logging in to the admin site |
| POST |
ResetPassword /ms-securities/api/auth/reset-password |
|
| POST |
ChangeForgotenPassword /ms-securities/api/auth/forgot-password |
*change password email template* **"Click here"** will redirect you to changing password form. See screenshot below. |
| Location | ||
| PUT |
UpdateUserLocation /ms-securities/api/user-locations/{id} |
Update UserLocation |
| GET |
FindOneUserLocation /ms-securities/api/user-locations/{id} |
FindOne UserLocation |
| POST |
CreateUserLocation /ms-securities/api/user-locations |
Create UserLocation |
| GET |
FindUserLocation /ms-securities/api/user-locations |
Find UserLocation |
| Activities | ||
| POST |
CreateUserActivity /ms-securities/api/user-activities |
Create UserActivity |
| PUT |
UpdateUserActivity /ms-securities/api/user-activities/{id} |
Update UserActivity |
| PUT |
UpdateUser /ms-securities/api/users/{id} |
Update User |
| POST |
CreateUser /ms-securities/api/users |
Create User |
| GET |
FindOneUserActivity /ms-securities/api/user-activities/{id} |
FindOne UserActivity |
| DELETE |
DeleteUserActivity /ms-securities/api/user-activities/{id} |
Delete UserActivity |
| GET |
FindUser /ms-securities/api/users |
Find User |
| GET |
FindOneUser /ms-securities/api/users/{id} |
FindOne User |
| GET |
FindUserActivity /ms-securities/api/user-activities |
Find UserActivity |
| Organization | ||
| GET |
AppController_health /ms-securities/api/health |
Monitoring the api connectivity. |
| GET |
FindOneUserOrganization /ms-securities/api/user-organizations/{id} |
|
| PUT |
UpdateUserOrganization /ms-securities/api/user-organizations/{id} |
|
| GET |
FindUserOrganization /ms-securities/api/user-organizations |
|
| DELETE |
DeleteUserOrganization /ms-securities/api/user-organizations/{id} |
|
| MS Venues | ||
| GET |
FindVenueOrganisation /ms-venues/api/organizations/5ed4ef97c318ff43e56edfd9 |
|
| GET |
FindOrganisationCities /ms-venues/api/organization-cities |
|
| GET |
FindAccount /ms-venues/api/accounts |
|
| GET |
FindOneVenue /ms-venues/api/venues/{id} |
FindOne Venue |
| MS Categories | ||
| GET |
FindCategory /ms-categories/api/settings |
|
| GET |
FindCuisine /ms-categories/api/cuisines |
|
| GET |
FindProduct /ms-categories/api/products |
|
| GET |
FindImage /ms-categories/api/images |
|
| GET |
FindProductGroups /ms-categories/api/product-groups |
|
| GET |
FindCountries /ms-categories/api/countries |
|
| GET |
FindVenueCategories /ms-categories/api/venue-categories |
|
| GET |
FindTags /ms-categories/api/tags |
|
| GET |
FindPaymentsType /ms-categories/api/payment-types |
|
Testing pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
