ciricihq/cirici-beacon-control-client-bundle

Symfony client for manage BeaconControl s2s API

dev-master 2018-01-09 15:11 UTC

Requires

• php: >=5.3.3
• eightpoints/guzzle-bundle: ^7.2

Requires (Dev)

• liip/functional-test-bundle: ^1.6
• phpunit/phpunit: 4.8.*|~5.2
• polishsymfonycommunity/symfony-mocker-container: ^1.0
• symfony/symfony: ~2.3.1|~2.7|~3.0
• symfony/var-dumper: ^3.1

GPL-3.0

• Cirici New Media
• Genar Trias Ortiz

• api
• jwt
• beacons

README

This bundle connects to BeaconControl api's to perform various actions

The documentation of the API can be found here: https://beaconcontrol.io/dev/backend/api_docs/index.html

Install

Require the bundle using composer:

composer require ciricihq/cirici-beacon-control-client-bundle:dev-master

Add it to AppKernel.php:

        $bundles = [
            ...
            new EightPoints\Bundle\GuzzleBundle\GuzzleBundle(),
            new Cirici\BeaconControlClientBundle\CiriciBeaconControlClientBundle(),
            ...
        ]

Configure the BeaconControl API endpoint for GuzzleBundle:

guzzle:
    clients:
        beacon_contol_s2s:
            base_url: "%beacon_control_s2s_api_base_url%"

Configuration

Add the next parameters to parameters.yml:

    beacon_control_s2s_api_id: <your beacon-control oauth api id>
    beacon_control_s2s_api_secret: <your beacon-control oauth api secret>
    beacon_control_s2s_admin_email: <your beacon-control admin email>
    beacon_control_s2s_admin_password: <your beacon-control admin password>
    beacon_control_s2s_api_base_url: <your beacon-control api base-url>

Enjoy!