spkm/isams

A PHP wrapper for using iSAMS public REST API

v4.1.2 2024-07-30 14:44 UTC

Requires

• php: ^8.2
• ext-json: *
• guzzlehttp/guzzle: ~6||~7
• illuminate/http: ~10||~11
• illuminate/support: ~10||~11
• intervention/image: ^2.7
• laravel/pint: ^1.16

Requires (Dev)

• phpunit/phpunit: ^10.0

Suggests

• laravel/framework: The Laravel Framework.

MIT

• Simon Mitchell
• Fred Bradley

• rest
• api
• laravel
• isams

README

This package is a PHP wrapper for iSAMS (https://isams.com) using their REST API. It transforms the json objects returned from the API into model instances.

See https://developerdemo.isams.cloud/Main/swagger/ui/index for their API documentation & https://developer.isams.com/display/PRA/Getting+started+-+REST+API

Installation and usage

This package requires PHP 8.1 & Laravel 9.0 or higher. See the tests/ folder for documentation. (We'd quite like someone to write some proper documentation)

Basic Installation:

You can install this package via composer using:

composer require spkm/isams

The package will automatically register its service provider

To publish the config file to config/isams.php run:

php artisan vendor:publish --provider="spkm\isams\IsamsServiceProvider"

Update the config file & add the REST API secret(s) to your .env file

If you are using a School model, implement the interface \spkm\isams\Contracts\Institution:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class School extends Model implements \spkm\isams\Contracts\Institution
{
    /**
     * Define the name used to identify this Schools entry in the config
     */
    public function getConfigName(): string
    {
        return 'cranleighSandbox';
    }
}

In your config/isams.php file, add the following to the schools array:

    'cranleighSandbox' => [
        'api_key' => env('ISAMS_API_KEY'),
        'api_secret' => env('ISAMS_API_SECRET'),
        'api_url' => env('ISAMS_API_URL'),
    ],

Otherwise implement the interface on your custom class (or copy the example spkm\isams\School)

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Simon Mitchell
• Fred Bradley
• All Contributors

License

The MIT License (MIT). Please see License File for more information.