README

A simple PHP SDK for VSL's Data Center API.

Using this sdk you can easily communicate with VSL's Data Center API

Here are a few examples of the provided methods:

use VelocitySportsLabs\DataCenter\Client;
use VelocitySportsLabs\DataCenter\HttpClient\Options;

// This file is generated by Composer
require_once __DIR__ . '/vendor/autoload.php';

$options = new Options([
    'auth_token' => 'token', // get this from your application profile
    'origin' => 'http://localhost', // you set this when creating your application
]);

$client = new Client($options);
$response = $client->countries()->list();

// this would give you a list of all countries supported by VSL
dump($response);

Requirements

To use this project you need:

Installation

You can install the package via composer by running:

composer require velocity-sports-labs/datacenter-php-sdk

How to obtain api keys

The first thing you will need to do is create or login to your account at VSL's Data Center API

Next up is create an application to get the api keys and origin

Make sure to copy your api keys as you will need it when setting up the client.

Usage

First instantiate the client

use VelocitySportsLabs\DataCenter\Client;
use VelocitySportsLabs\DataCenter\HttpClient\Options;

// This file is generated by Composer
require_once __DIR__ . '/vendor/autoload.php';

$options = new Options([
    'auth_token' => 'token', // get this from your application profile
    'origin' => 'http://localhost', // you set this when creating your application
]);

$client = new Client($options);

Now that you have the client you can access all available endpoints. Like shown below

<?php

// use the request helper to access endpoints
$countries = $client->request('countries')->list();

// or use the magic method to access endpoints
$countries = $client->countries()->list();

More documentation to come

Testing

Run the tests with:

vendor/bin/pest

Roadmap

Here are a list of outstanding tasks to do:

add documentation for every request
add tests for every requests

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail abdulkudus2922@gmail.com instead of using the issue tracker.

Credits

License

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

velocity-sports-labs / datacenter-php-sdk

Maintainers

Details