smartapps/php-api

A library to connect on S.M.A.R.T platform that can integrate webpages with smart data

SMARTAPPS API Client PHP

This library can help developers create webpages integrated with S.M.A.R.T platform (www.smartapps.com.br), _(*1)

Requirements

- Composer
- cUrl Library
- PHP >= 5.3

Source

You can found the source of library in the src folder., _(*2)

Install examples with composer

1. First step, Install composer :)

To do it, you need run composer install or php compose.phar install., _(*3)

2. Install library

You need install this library using Composer. So, add package name smartapps/php-api on the dev-master version in your composer.json. If you want do it using CLI, run the command: composer require "smartapps/php-api:dev-master"., _(*4)

3. Run example :D

On the main folder, you can run the file opening into your browser or you can run the example with CLI: php examples/basic_data.php, _(*5)

Examples

Basic data (basic_data.php)

This example show how to get data from a application, _(*6)

Exec method (exec_method.php)

This example show how to execute a method on a application, _(*7)

Post simple (exec_method_post_simple.php)

This example show to send a simple block of data., _(*8)

Post massive data (exec_method_post_massive.php)

This example show how to send a array of data to any method on a application, _(*9)

View forms

This example show how you can see forms avaiables on a application., _(*10)

View schemas

This example show how you can see data schemas to a application., _(*11)

Note: if you liked the examples and you want more, feel free and help us. let's go change the world using the web., _(*12)

Library methods

Below you can see methods avaiable for this library., _(*13)

connect($app, $api_user=false, $api_key=false)

You need use this method to connect on S.M.A.R.T, _(*14)

Params

$app        : Application that you want connect.
$api_user   : API USER :P, You can found yours, on 'API Tool' in the option 'registered keys' on your enviroment.
$api_key    : API KEY :P, You can found it on 'API Tool' in your environment.

connectionClose()

You need use this method to disconnect of S.M.A.R.T, _(*15)

method($conn, $schema, $method, $args=false, $return="json", $app=false)

You can use this method to do a GET request directly using a method as reference., _(*16)

Params

$conn       : Connection object reference, found it on return of method connect
$schema     : Schema of data
$method     : Method name
$args       : Array of arguments that method need.
$return     : Type of request return
$app        : Subscribe application when execute this method.

methodPost($conn, $schema, $method, $postVars, $args=false, $return="json", $app=false)

You can use this method to do a POST request directly using a method as reference., _(*17)

Params

$conn       : Connection object reference, found it on return of method connect
$schema     : Schema of data
$method     : Method name
$args       : Array of arguments that method need.
$return     : Type of request return
$app        : A way to subscribe application after connected.

getSchemas($conn)

You can use this method to see which schemas avaiable on a app., _(*18)

Params

$conn       : Connection object reference, found it on return of method connect.

getForms($conn, $schema)

You can use this method to see forms., _(*19)

Params

$conn       : Connection object reference, found it on return of method connect.
$schema     : Schema of data.

getData($conn, $schema, $form)

You can use this method to get data., _(*20)

Params

$conn       : Connection object reference, found it on return of method connect.
$schema     : Schema of data.
$form       : Form name.

getFile($conn, $file, $mime, $date)

You can use this method to get a filepath., _(*21)

Params

$conn       : Connection object reference, found it on return of method connect.
$file       : File name.
$mime       : Mimetype of the file.
$date       : Date file registry.

sendExec($conn, $app, $schema, $form, $postVars, $return="json")

You can use this method to send data to a form., _(*22)

Params

$conn       : Connection object reference, found it on return of method connect.
$app        : Application.
$schema     : Schema of data.
$form       : Form name.
$postVars   : Array data for send.
$return     : Return of request.

sendTo($conn, $schema, $form, $postVars=false, $app=false)

You can use this method to send data to a form directly., _(*23)

Params

$conn       : Connection object reference, found it on return of method connect.
$app        : Application.
$schema     : Schema of data.
$form       : Form name.
$postVars   : Array data for send.
$app        : A way to subscribe application after connected.

If you want more details about API Tool of S.M.A.R.T Platform, see API Docs on Smartapps web site (www.smartapps.com.br)., _(*24)

@author José Wilker jose.wilker@smartapps.com.br, _(*25)