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 variables. - Navigate to [API Management service](https://portal.azure.com/#home) - Select the corresponding API resources, for this example we will use the apimiyou gateway. - From the left menu, select **Subscriptions**, show the keys of **API-Documentation** and get the **primary key** value. > See screenshot below for reference ![subscription12PNG](https://user-images.githubusercontent.com/17892486/93983126-c1778e80-fdb4-11ea-90c6-a310b767564f.PNG) 3. In Postman, paste the value in the header with a key of **vivacity-subscription**. > The ```subscription key``` indicates the product which the data in this request is associated and authenticates the requester as someone who is allowed to make the request. It **must** be included with every request as a HTTP Authorization header. 4. For more information about authentication permissions, see our credential key [here](https://dev.azure.com/vivacityapp/Viva/_wiki/wikis/Web-Apps.wiki/) > **NOTE**: The old api gate-way which is **apiviva** is using **Ocp-Apim-Subscription-Key** key as header for the subscription. 5. Click Send. You can now test the rest of your API endpoints using the other Viva City folders and requests

Subscription Key related error response

If an Subscription Key is missing, malformed, invalid, you will receive a **401 Access Denied** response code and the following JSON response:

{
    "statusCode": 401,
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}

---

Api Gateways

Here are the list of Menu App api gate-way with their current location. >**NOTE**: api under apiviva will be migrated to apimiyou - **apimiyou** - Algolia - B2B - Multi-Language - **apiviva** - Venue Recommendations - Menu Order - WeChat User Information - Http Trigger Post Location ---

Documention Overview

Reference documentation for API endpoints consists of five general sections: resource descriptions, endpoints and methods, parameters, sample requests, and sample responses and schemas. ![Part0](https://user-images.githubusercontent.com/17892486/93567695-a0ccc480-f9c1-11ea-9762-3e499783546f.png) - **PART I: Resource description** - Resources refers to the information returned by an API. Most APIs have various categories of information, or various resources, that can be returned. - **PART II: Endpoints and methods** - The endpoints indicate how you access the resource, while the method indicates the allowed interaction(such as GET, POST, or DELETE) with the resource. - **PART III: Parameters** - Parameters are options you can pass with the endpoint (such as specifying the response format or the amount returned) to influence the response. There are several types of parameters: header parameters, path parameters, and query string parameters. - **PART IV: Request example** - The request example includes a sample request using the endpoint, showing some parameters configured. - **PART V: Response example and schema** - The response example shows a sample response from the request example; the response schema defines all possible elements in the response.

Examples of API Documentation

Here’s an example from one of our API: [//]: # (Place the Hex color you want in the url below, in this example, f7e4c0) ![#f7e4c0](https://placehold.it/15/f7e4c0/000000?text=+) Resources Description [//]: # (Place the Hex color you want in the url below, in this example, d69490) ![#d69490](https://placehold.it/15/d69490/000000?text=+) Endpoints and methods [//]: # (Place the Hex color you want in the url below, in this example, a0d690) ![#a0d690](https://placehold.it/15/a0d690/000000?text=+) Parameters [//]: # (Place the Hex color you want in the url below, in this example, 90ccd6) ![#90ccd6](https://placehold.it/15/90ccd6/000000?text=+) Request example [//]: # (Place the Hex color you want in the url below, in this example, d6d590) ![#d6d590](https://placehold.it/15/d6d590/000000?text=+) Response example

![example1 2](https://user-images.githubusercontent.com/17892486/93590749-a934f780-f9e1-11ea-8ece-b85a813540f2.png)

Cargando API Playground