README

This package is a collection of AITS api's. It provides and easy way to integrate and use AITS api endpoints in Laravel applications.

Installation

Since this is a private package we cannot use composer to install the package from the repository.

Instead, we need to rely on GitHub repository to fetch the package directly.

Install the package by editing your copmoser.json file and add the repositories key to the file:

"repositories": [
  {
    "type": "vcs",
    "url": "git@github.com:uisits/aits-api.git"
  }
]

Next run composer require uisits/aits-api

To get the latest version of the application please visit https://github.com/uisits/aits-api/releases and check the latest release compatible with your application version.

Publish the config file:

php artisan vendor:publish --tag=aits-api

Lastly, configure the environment variables.

AITS_BASE_URL=https://webservices-test.admin.uillinois.edu/studentWS/data/edu.uis.its.apps/
AITS_PERSON_BASE_URL=https://webservices-test.admin.uillinois.edu/personWS/data/edu.uis.its.apps/

AITS_AZURE_PORTAL_KEY='xxxxxxxxxxx'
AITS_AZURE_BASE_URL=https://api.apps.uillinois.edu/

If you want to setup proxy server, add the details of proxy server to your .env

AITS_PROXY_HOST='xx.xx.xx.xx'
AITS_PROXY_PORT='xxxx'
AITS_PROXY_USERNAME='xxxxx'
AITS_PROXY_PASSWORD='xxxxxxxxxxxxxxx'

Please refer to GitHub Wiki page for api documentation.

uisits / aits-api

Maintainers

Details

README

Installation