README

Client for the REST API at developers portal of IAIP.

Note: This package is under development and should not be used in production sites, until version 1.0.0 or above is released.

Dependencies

Installation

Via Composer

$ composer require iaipes/apiclient

Configuration

Laravel

Publish configuration

php artisan vendor:publish --provider aipes\ApiClient\ApiClientServiceProvider

Configure the next variables in you .env file:

IAIPES_API_TOKEN={token}
IAIPES_API_URL=http://developers.iaip.iw.sv
IAIPES_API_TIMEOUT=10

Note: replace {token} with your developer access token.

Usage

PHP

// Load dotenv if you have not (Not necessary in Laravel)
$dotenv = new Dotenv\Dotenv(__DIR__);
$dotenv->load();

use Iaipes\ApiClient\Http\Client\Api\V1\InformationRequestClient;

$client = new InformationRequestClient;

$response = $client->index([
        'include' => 'institution',
        'filter' => [
            'profession_cont' => 'Desarrollador'
        ],
        'sort' => 'created_at desc'
    ]);

Note: For more information about classes and methods, please check the documentation

Change log

Please see the changelog for more information on what has changed recently.

Testing

Create a .dot file inside the tests folder

IAIPES_API_TOKEN={token}
IAIPES_API_URL=http://developers.iaip.iw.sv
IAIPES_API_TIMEOUT=30

Note: Replace {token} with your developer access token

Run the rest with the next command

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits

License

license. Please see the license file for more information.

iaipes / apiclient

Maintainers

Details