With HTTP request response we utilize standard HTTP 1.1 protocols for posting information to a webservice that you will specify to us OR we will utilize standard HTTP 1.1 protocols for responding to the requests that come from your system. Whether we post or respond is based on the specific function being invoked.
Throughout this documentation we will be using the variables to define how you may interact with the various api methods. There are specific variables which indicate pre-defined information and there are generic variables which indicate information that relates only to the current method that is executing.
| Name | Description |
|---|---|
| [API] | This is the domain name for the VS API which can be used to create HTTP requests or persistent socket connections. |
| [KEY] | This is your personal key for accessing the API. You should be notified by email what this value is for your account. |
| [YOUR_API_HOST] | This is the hostname or IP that you will provide to us so that our system can inform you of realtime changes. |
| [YOUR_API_URI] | This is the path on [YOUR_API_HOST] where the script resides that we will communicate with. |
| [SERVICE] | This can be one of the following values: girls, guys or trans. The default value is girls if none is supplied. |
| [ROOMTYPE] | This can be one of the following values: standard, multiuser, combo, group or party. |
| [SHOWTYPE] | This can be one of the following values: private, voyeur or multiuser. |
| Name | Description |
|---|---|
| [category] | This is the name of the category in which a performer has placed themselves. |
| [centimeters] | This is a length in centimeters. |
| [country] | This is a 2 character country code. |
| [cpm] | This is the cost per minute for the [SHOWTYPE] in question. |
| [credits] | This is an amount of credits in whole numbers. |
| [id] | This is a unique identifier for the information being delivered. |
| [int] | This indicates an integer based value for a variable that does not have fixed values. |
| [ip] | This is an ip address. |
| [kilograms] | This is a weight in kilograms. |
| [name] | This is a name for the information being delivered. |
| [state] | This is a 2 character code for US states. |
| [timestamp] | This is a unix timestamp. |
| [topic] | This is a string which is defined by the performer to advertise his/her room. |
| [url] | This is a fully qualified URL. |
| [string] | This indicates a character based value for a variable that does not have fixed values. |
| [#hex] | This indicates that a hex value, preceeded by the # sign will be provided to define a specific color. |