Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/20steps/placetel-bundle
Service-oriented Placetel API for Symfony2 applications by http://20steps.de
https://github.com/20steps/placetel-bundle
Last synced: 17 days ago
JSON representation
Service-oriented Placetel API for Symfony2 applications by http://20steps.de
- Host: GitHub
- URL: https://github.com/20steps/placetel-bundle
- Owner: 20steps
- License: lgpl-3.0
- Created: 2014-02-01T12:29:08.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-02-04T14:30:32.000Z (almost 11 years ago)
- Last Synced: 2024-11-13T04:38:25.021Z (3 months ago)
- Language: PHP
- Size: 137 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 20steps/placetel-bundle (twentystepsPlacetelBundle)
## About
The 20steps Placetel Bundle provides a Service-oriented API for Symfony2 applications that need to interact with the Placetel monitoring service.
For further information about Placetel goto http://www.placetel.de.
## Features
- [x] Placetel accessible as a configurable Symfony2 service.
- [ ] Complete API for Placetel.
- [x] Configurable caching of responses to prevent surpassing rate limit.
- [x] Provide some derived KPIs.
- [ ] Full documentation and some examples.
- [ ] Prepare for open sourcing of 20steps control.
## Installation
Require the bundle by adding the following entry to the respective section of your composer.json:
```
"20steps/placetel-bundle": "dev-master"
```
Get the bundle via packagist from GitHub by calling:
```
php composer.phar update 20steps/placetel-bundle
```
Register the bundle in your application by adding the following line to the registerBundles() method of your AppKernel.php:
```
new twentysteps\Bundle\PlacetelBundle\twentystepsPlacetelBundle()
```
Register services provided by the bundle by adding the following line to the imports section of your config.yml:
```
- { resource: "@twentystepsPlacetelBundle/Resources/config/services.yml" }
```
Define the following properties in your parameters.yml:
* twentysteps_placetel.url - URL of the Placetel API - normally should point to "https://api.placetel.de/api/".
* twentysteps_placetel.api_key - API key of your account at Placetel.
* twentysteps_placetel.timeout - Timeout in seconds to apply on calls of the Placetel API - you should use 10.
* twentysteps_placetel.connect_timeout - Connect timeout in seconds to apply on calls to the Placetel API - you should use 5.
* twentysteps_placetel.cache_ttl - Cache TTL to apply on responses of the Placetel API - you should use 3600.
## Usage
* Get reference to the Placetel service either by adding @twentysteps_placetel.service as a dependency in your service or by explicitely getting the service from the container during runtime e.g. by calling $this->get('twentysteps_placetel.service') in the action of your controller.
* Call any public function provided by Services/PlacetelService.php e.g. getServices() to get the monitoring services listed in Placetel.
## Version
This version is not yet complete or usable.
## Author
Helmut Hoffer von Ankershoffen ([email protected]).