|  | 
|  | 1 | +# VitaCloud Quotes Connector | 
|  | 2 | +VitaCloud Quotes API provides a curated set of quotes by famous authors and celebrities, tagged with various themes such as faith, god, happiness, hope, humour, inspiration, knowledge, life lessons, love, motivation, philosophy, poetry, relationship, religion, romance, science, time, truth, and wisdom. VitaCloud Quotes API connector is a wrapper around the VitaCloud Quotes API that enables bringing the tailored, daily and random VitaCloud Quotes into your workspace using Microsoft Power Automate, Microsoft Power Apps, and Azure Logic Apps in your Azure and Office 365 subscription.  | 
|  | 3 | + | 
|  | 4 | +## Publisher: VitaCloud Limited | 
|  | 5 | +<a href="https://www.vitacloud.co.uk" target="_blank">VitaCloud Website</a><br/> | 
|  | 6 | +<a href="https://portal.vitacloud.co.uk/home" target="_blank">VitaCloud API Portal</a><br/> | 
|  | 7 | +<a href="mailto:support@vitacloud.co.uk">VitaCloud Support</a><br/> | 
|  | 8 | + | 
|  | 9 | +## Prerequisites | 
|  | 10 | +You will need the following to proceed: | 
|  | 11 | +* A VitaCloud API Base URL | 
|  | 12 | +* A VitaCloud API Key | 
|  | 13 | +* A Microsoft Power Apps or Power Automate plan with custom connector feature | 
|  | 14 | +* The Power platform CLI tools | 
|  | 15 | + | 
|  | 16 | +## Supported Operations | 
|  | 17 | +The connector supports the following operations | 
|  | 18 | + | 
|  | 19 | +* `Get authors`: Get all authors | 
|  | 20 | +* `Get author`: Get a specific author by `authortag` | 
|  | 21 | +* `Get themes`: Get all themes | 
|  | 22 | +* `Get theme`: Get a specific theme by `themetag` | 
|  | 23 | +* `Get quotes`: Get 5 random quotes | 
|  | 24 | +* `Get quotes by number`: Get the specified number of random quotes (max 10) | 
|  | 25 | +* `Get quotes by author`: Get 5 random quotes for specific author by `authortag` | 
|  | 26 | +* `Get quotes by author and number`: Get the specified number of random quotes for specific author by `authortag` (max 10) | 
|  | 27 | +* `Get quotes by theme`: Get 5 random quotes for specific theme by `themetag` | 
|  | 28 | +* `Get quotes by theme and number`: Get the specified number of random quotes for specific theme by `themetag` (max 10) | 
|  | 29 | +* `Get random quote`: Get a random quote | 
|  | 30 | +* `Get today's quote`: Get today's quote | 
|  | 31 | + | 
|  | 32 | +## Obtaining Credentials | 
|  | 33 | +### Steps to generate the API Base URL and API Key | 
|  | 34 | + | 
|  | 35 | +1. Sign up or log in to the <a href="https://portal.vitacloud.co.uk/home" target="_blank">VitaCloud API Portal</a><br/> | 
|  | 36 | +<img src="https://vitacloud.blob.core.windows.net/company/portalhome.JPG" alt="Portal home" width="1200"/> | 
|  | 37 | + | 
|  | 38 | +2. Subscribe to one of the free or paid products from the Product catalog<br/> | 
|  | 39 | +<img src="https://vitacloud.blob.core.windows.net/company/products.JPG" alt="Product catalog" width="1200"/> | 
|  | 40 | + | 
|  | 41 | +3. Select the subscribed product in the portal<br/> | 
|  | 42 | +<img src="https://vitacloud.blob.core.windows.net/company/selectproduct.jpg" alt="Select subscribed product" width="1200"/> | 
|  | 43 | + | 
|  | 44 | +4. Copy the **Base Product URL** and **API Key** from the **Authentication** tab<br/>  | 
|  | 45 | +<img src="https://vitacloud.blob.core.windows.net/company/authentication.jpg" alt="Authentication" width="800"/> | 
|  | 46 | + | 
|  | 47 | +> The **Base Product URL** and **API Key** will be required for connecting to the Quotes connector in Power Automate and Power Apps. | 
|  | 48 | +
 | 
|  | 49 | +## Known Issues and Limitations | 
|  | 50 | + | 
|  | 51 | +* Please note some functionality may be limited based on the subscribed product. E.g. if only **Today's Quote** product is subscribed, only the **Get Today's Quote** action will work in the connector.  | 
|  | 52 | +* We recommend subscribing to the **Quotes by themes and authors** product to unlock all options in the connector. | 
|  | 53 | +* If number of quotes is not specified for operations requiring them, then at most 5 quotes will be returned in the response. | 
|  | 54 | +* Number of quotes returned will be limited to a maximum of 10. | 
|  | 55 | +* Some authors may not have a corresponding Wikipedia link. | 
|  | 56 | +* Author images are subject to change, but will maintain the same size and aspect ratio. | 
|  | 57 | +* If an incorrect Base Product URL or API Key is specified, HTTP status code `404 - not found` will be returned, alongwith a response as below <br/> | 
|  | 58 | +`{"requestId": long string, "message": "No data product found. Please contact your data provider"}` <br/> | 
|  | 59 | +Please update the connection with the correct **Base Product URL** and **API Key** from the API portal. | 
|  | 60 | + | 
|  | 61 | +* If an action is used that is not included in the product corresponding to the Base Product URL, HTTP status code `403 - forbidden` will be returned, alongwith a response as below <br/> | 
|  | 62 | +`{"requestId": long string, "message": "Endpoint not available"}` <br/> | 
|  | 63 | +Update the connection with the **Base Product URL** corresponding to the product containing the requested endpoint. | 
|  | 64 | + | 
|  | 65 | +## Frequently Asked Questions | 
|  | 66 | +* **How can I track the number of calls made for the subscribed product?**<br/> | 
|  | 67 | +In the <a href="https://portal.vitacloud.co.uk/home" target="_blank">VitaCloud API Portal</a>, select the subscribed product.<br/> | 
|  | 68 | +<img src="https://vitacloud.blob.core.windows.net/company/selectproduct.jpg" alt="select action" width="800"/><br/> | 
|  | 69 | +The **Overview** tab for the selected product will show the number of API calls made against the available quota. | 
|  | 70 | + | 
|  | 71 | +* **How can I consume the APIs directly in a website or app?**<br/> | 
|  | 72 | +Download the OpenAPI 3.0 specification for your subscribed endpoints on the **Overview** tab for your product. Please include the API key in the header for your request to the endpoints. Select an endpoint in the **Endpoints** tab to try out a request in the portal. You can also copy code snippets available in Curl, JavaScript, Python, Go, Ruby and PhP from the portal. | 
|  | 73 | + | 
|  | 74 | +* **What themes and authors are included?** | 
|  | 75 | +The Quotes connector `Get Themes` action provides over 20 themes to choose from, including popular ones like humour, wisdom, science, inspiration, philosophy and happiness. The `Get Authors` action provides details for over 700 authors, personalities and celebrities. Most endpoints also include authors' images and wikipedia links, where available.<br/> | 
|  | 76 | +<img src="https://vitacloud.blob.core.windows.net/company/authors1.png" alt="authors" width="400"/> | 
|  | 77 | +<img src="https://vitacloud.blob.core.windows.net/company/themes.png" alt="themes" width="400"/> | 
|  | 78 | +<img src="https://vitacloud.blob.core.windows.net/company/authors2.png" alt="authors" width="400"/> | 
|  | 79 | + | 
|  | 80 | +* **Where can I reach out if I have a product query or require support?**<br/> | 
|  | 81 | +Please send your query to <a href="mailto:support@vitacloud.co.uk">VitaCloud Support</a> or fill out the contact form on the <a href="https://www.vitacloud.co.uk" target="_blank">VitaCloud Website</a>. | 
|  | 82 | + | 
|  | 83 | +## Deployment Instructions | 
|  | 84 | +Run the following commands and follow the prompts: | 
|  | 85 | + | 
|  | 86 | +```paconn | 
|  | 87 | +paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json | 
|  | 88 | +``` | 
0 commit comments