Developer
This page explains how to interact with Voila from another app: send cards, dates, numbers and keywords with a voila:// link, or let Voila fetch data from your API.
Last updated:
You can send data to Voila using the Voila URL scheme. URLs use this format: voila://[action]?[params]
[params] depends on the [action] you are calling. Each action lists its own parameters below.
input actionHere are the parameters you can use with the input action:
| Parameter | Sends | Value |
|---|---|---|
card | A card | 2 characters: rank + suit |
position | A card, by its position in the user's stacked deck | Integer from 1 to 52 |
date | A date | Unix timestamp, in seconds |
number | A number | Non-negative integer |
keyword | A keyword | URL-encoded string |
Here are some examples of URLs that work with the input action:
Sends the Three of Diamonds to Voila.
Sends the Ten of Hearts and “Guillaume Bellut” to Voila.
Sends the Three of Diamonds (12th card in Mnemonica), June 8th, 2017, and 456 to Voila.
cardSends a card to Voila. The value must be 2 characters long: the first one is the card's rank and the second one its suit.
1Ace2Two3Three4Four5Five6Six7Seven8Eight9Nine0TenJJackQQueenKKingS♠ SpadesH♥ HeartsC♣ ClubsD♦ DiamondsJJJokerThe Joker can't be sent at the moment.
1CAce of Clubs3DThree of Diamonds0STen of SpadesKHKing of HeartsJJJokerpositionSends a card to Voila using its position in the user's stacked deck. The value must be an integer between 1 and 52.
1Four of Clubs52Nine of DiamondsdateSends a date to Voila. The value must be a Unix timestamp, in seconds.
601302600January 20th, 19891604349590November 2nd, 2020numberSends a number to Voila. The value must be a non-negative integer.
1231234567890keywordSends a keyword to Voila. The value must be a URL-encoded string.
Steve%20JobsDaft%20PunktigerVoila can fetch data from any API URL.
Users can map any key from a JSON dictionary, or any plain string, to a Voila keyword. Keywords can then be used in Voila tricks.
Please contact us if you'd like to talk about connecting your product with Voila.
[email protected]