visupedia/visupedia

Official Visupedia API library client for PHP

visupedia-api-php

Official Visupedia API library client for PHP, _(*1)

This library is generated by alpaca, _(*2)

Installation

Make sure you have composer installed., _(*3)

Add the following to your composer.json, _(*4)

{
    "require": {
        "visupedia/visupedia": "@dev"
    }
}

Update your dependencies, _(*5)

$ php composer.phar update

This package follows the PSR-0 convention names for its classes, which means you can easily integrate these classes loading in your own autoloader., _(*6)

Versions

Works with [ 5.4 / 5.5 ], _(*7)

Usage

<?php

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

// Then we instantiate a client (as shown below)

Build a client

Without any authentication

$client = new Visupedia\Client();

// If you need to send options
$client = new Visupedia\Client(array(), $clientOptions);

Client Options

The following options are available while instantiating a client:, _(*8)

• base: Base url for the api
• api_version: Default version of the api (to be used in url)
• user_agent: Default user-agent for all requests
• headers: Default headers for all requests
• request_type: Default format of the request body

Response information

All the callbacks provided to an api call will recieve the response as shown below, _(*9)

$response = $client->klass('args')->method('args', $methodOptions);

$response->code;
// >>> 200

$response->headers;
// >>> array('x-server' => 'apache')

Method Options

The following options are available while calling a method of an api:, _(*10)

• api_version: Version of the api (to be used in url)
• headers: Headers for the request
• query: Query parameters for the url
• body: Body of the request
• request_type: Format of the request body

Request body information

Set request_type in options to modify the body accordingly, _(*11)

RAW request

When the value is set to raw, don't modify the body at all., _(*12)

$body = 'username=pksunkara';
// >>> 'username=pksunkara'

Visu api

Returns an MyVisu api instance, _(*13)

The following arguments are required:, _(*14)

• key: The api key provided by Visupedia

$visu = $client->visu("53214f86e2ae54.93050075");

Query a Visu (GET /api?key=:key&id=:id&lang=:lang&version=:version)

Returns all information about the wanted Visu, _(*15)

The following arguments are required:, _(*16)

• id: The unique ID of the Visu
• lang: The language code wanted for the Visu
• version: Use a specific version of our API

$response = $visu->get("5396d8c752cfd8.93460735", "fr", "2", $options);

Contributors

Here is a list of Contributors, _(*17)

TODO

License

MIT, _(*18)

Bug Reports

Report here., _(*19)

Contact

Gaël Gillard (dev@visupedia.net), _(*20)