A PHP wrapper for the flexmls REST API.
For full information on the API, see http://www.flexmls.com/developers
# include flexmlsAPI.php and set up instance of flexmlsAPI
require_once("flexmlsAPI.php");
$api = new flexmlsAPI("api_key_goes_here", "api_secret_goes_here");
# identify your application (optional)
$api->SetApplicationName("MyPHPApplication/1.0");
# authenticate
$result = $api->Authenticate();
if ($result === false) {
echo "API Error Code: {$api->last_error_code}<br>\n";
echo "API Error Message: {$api->last_error_mess}<br>\n";
exit;
}
# get your listings
$result = $api->GetMyListings();
# see the included examples.php for more complete usage
| HTTP Code | flexmls API Error Code | Automatic Retry | Description |
|---|---|---|---|
| 401 | 1000 | Yes | Invalid API Key and/or Request signed improperly |
| 401 | 1010 | No | API key is disabled |
| 403 | 1015 | No | ApiUser must be supplied, or the provided key does not have access to the supplied user |
| 401 | 1020 | Yes | Session token has expired |
| 403 | 1030 | No | SSL required for this type of request |
| 400 | 1035 | No | POST data not supplied as valid JSON. Issued if the Content-Type header is not application/json/ and/or if the POST data is not in valid JSON format. |
| 400 | 1040 | No | The _filter syntax was invalid or a specified field to search on does not exist |
| 400 | 1050 | No | (message varies) A required parameter was not provided |
| 400 | 1053 | No | (message varies) A parameter was provided but does not adhere to constraints |
| 409 | 1055 | No | (message varies)Issued when a write is requested that will conflict with existing data. For example, adding a new contact with an e-mail that already exists. |
| 403 | 1500 | No | The resource is not available at the current API key's service level. For example, this error applies if a user attempts to access the IDX Links API via a free API key. |
| 503 | 1550 | No | Over rate limit |