Giter Club home page Giter Club logo

toolbox's Introduction

E-Contract BVBA - Toolbox package

This package offers the integration of the econtract Toolbox API. This API can be used by partners and affiliates of econtract to leverage various services and utility resources owned by econtract on their own websites.

Installation

Pull this package in through Composer:

    {
        "require": {
            "econtract/toolbox": "2.*"
        }
    }

Next, you will need to add several values to your .env file:


    TOOLBOX_API_ENDPOINT=https://toolbox.econtract.be       // Toolbox API key URL that is to be used
    TOOLBOX_API_KEY=your_toolbox_key                        // Toolbox API key that will authenticate you in our system.

In order to use the API (and thus this package), an API key is required. If you are in need of such a key, please get in touch with Aanbieders.be via their website.

Laravel installation

Add the service provider to your config/app.php file:

    'providers'             => array(

        //...
        \Econtract\Toolbox\ToolboxServiceProvider::class,

    )

Add the API as an alias to your config/app.php file

    'facades'               => array(

        //...
        'Toolbox'               => \Econtract\Toolbox\Facades\Toolbox::class,

    ),

Usage

Laravel usage

You can access the API using the alias you have selected in your config/app.php file:

    
    $cities = Toolbox::getCities(
        array(
            'query'     => 'Kort',
        )
    );

    $city = Toolbox::getCity( $id );

    $addresses = Toolbox::getAddresses(
        array(
            'street'        => 'markt',
            'postcode'      => '350',
            'city'          => 'ru',
        )
    );

For information regarding all possible parameters and their properties, we kindly refer you to the API documentation.

Non-laravel usage

    include('vendor/autoload.php');

    use Econtract/Toolbox/ToolboxService;


    $dotenv = new Dotenv\Dotenv(__DIR__);
    $dotenv->load();


    $toolboxService = new ToolboxService();
    $toolboxService->getAddresses(
        array(
            'street'        => 'markt',
            'postcode'      => '350',
            'city'          => 'ru',
        )
    );

License

This package is proprietary software and may not be copied or redistributed without explicit permission.

Contact

Evert Engelen (owner)

Jan Oris (developer)

toolbox's People

Contributors

bpasinski-neurosys avatar elimentz avatar

Watchers

 avatar

Forkers

arslanzeropoint

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.