When one of your customers wishes to send a performer a tip, you can POST to the following URL:
POST /tip?key=[KEY] HTTP/1.1
Host: [API]:80
performerId=[id]
&customerId=[id]
&nickname=[nickname]
&credits=[int]
&ipAddress=[ipAddress]
NOTE: The post variables should all be on 1 line. We have separated them here for visual clarity only.
| Name | Required | Type | Description |
|---|---|---|---|
| key | Yes | string | Supplied by VS. Please ask us for your key. |
| performerId | Yes | integer | The id of the performer you would like to tip. |
| customerId | Yes | integer | The id of the customer that is doing the tipping. |
| nickname | Yes | string | The nickname of the customer that is doing the tipping. |
| credits | Yes | integer | The amount of credits to tip the performer. |
| ipAddress | Yes | string | The ip address of the customer that is giving the tip. |
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: [int]
{
success: true | false
message: [string]
transactionId: [string]
}
| Name | Description |
|---|---|
| success | Whether or not your post was successful. |
| message | An error message if success is false. |
| transactionId | The unique ID of the tipping transaction. |
Developers can call this method whether or not the performer is online. If the performer is online a system message will be delivered to the performer's room which all customers can see.