Add "jaybizzle/deploybot-api": "1.*"
to your composer.json.
You can read the official DeployBot API documention here - http:https://deploybot.com/api/
All the DeployBot API endpoints can be called by prefixing the name with get
e.g
use Jaybizzle\DeployBot;
$db = new DeployBot('YOUR_API_KEY', 'YOUR_ACCOUNT_NAME');
// get all users
$users = $db->getUsers();
// get a specific user
$user = $db->getUsers(324);
Some DeployBot API endpoints can accept query string parameters, such as limit
to limit the number of results returned. Taking the above users example, we can simply do this...
$users = $db->limit(10)->getUsers();
These can also be chained...
$users = $db->limit(10)->after(324)->getUsers();
Some more examples...
// list deployments for environment and limit results
$deployments = $db->environmentId(3452)->limit(10)->getDeployments();
NOTE: Query parameters are listed in the DeployBot API docs as snake_case
but we access them using camelCase
methods so all method calls have a consistent naming convention