PHPackages                             scoilnet/php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. scoilnet/php-sdk

ActiveLibrary[Utility & Helpers](/categories/utility)

scoilnet/php-sdk
================

Scoilnet SDK for PHP

015PHP

Since Nov 3Pushed 11y ago1 watchersCompare

[ Source](https://github.com/Scoilnet/PhpSDK)[ Packagist](https://packagist.org/packages/scoilnet/php-sdk)[ RSS](/packages/scoilnet-php-sdk/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Scoilnet PHP SDK
================

[](#scoilnet-php-sdk)

Scoilnet's API allows you to easily search resources from scoilnets database on you own site.

For full documentation, see [Scoilnet's developer documentation](https://www.scoilnet.ie/scoilnet-api/documentation)

Also check out the [Scoilnet PHP SDK Demo](https://github.com/Scoilnet/PhpSDKDemo) that you can install on your own server.

Installation
------------

[](#installation)

Installation is a quick 4 step process:

1. Install ScoilnetSDK
2. Create your cache folder
3. Get API authentication keys from Scoilnet
4. Configuration search paramaters.

### Step 1: Install ScoilnetSDK

[](#step-1-install-scoilnetsdk)

The preferred way to install this library is to rely on [Composer](http://getcomposer.org). Just check on [Packagist](https://packagist.org/packages/scoilnet/php-sdk) the version you want to install (in the following example, we used "dev-master") and add it to your `composer.json`:

```
{
    "require": {
        // ...
        "Scoilnet/PHPSDK": "dev-master"
    }
}
```

Alternatively you can download the scoilnetsdk folder and add it to your project.

### Step 2: Create your cache folder

[](#step-2-create-your-cache-folder)

For best performance a cache folder should be created that php can write too, but is not accessible by the web server.

### Step 3:Get API authentication keys from Scoilnet

[](#step-3get-api-authentication-keys-from-scoilnet)

To use the api you will need to login too scoilnet and obtain a client id, client secret key and api key. Go to the \[scoilnet api section\] () for more information on how to obtain the application keys.

### Step 4: Configuration

[](#step-4-configuration)

For all requests, you must initialize the SDK with your Client ID, Client Secret and API Key.

```