Square Works API

Bien débuter

L'API Square Works est un service web utilisant le protocol REST une autentification OAuth. Cette technologie est utilisable sur la pluspart de vos languages de programmation préférés.

Vous trouverez ci-dessous des échantillons de code a utiliser sirectement dans vos scripts. Téléchargez la librairie correspondante à votre language de programmation, copiez le code qui vous intéresse dans cette page et la console, c'est prêt !

PHP jQuery Angular apc.js

Echantillons de code pour PHP

Square Works met à votre disposition une classe PHP permettant de simplifier l'utilisation de l'API.

Cette classe est déjà disponible dans le Framework APC PHPKOD™. Si vous développez votre projet en dehors de notre framework, vous pouvez télécharger la librairie ci-dessous.

Dès que vous avez obtenu votre clé d'application et votre clé secrète vous pouvez commencer à utiliser l'API.

 

 Télécharger la classe PHP
Fichier zip, 7ko
 

Code minimal Librairie

require_once(’ApcApi.class.php’);
$api = new ApcApi(
‘applicationKey’,
‘applicationSecret’,
‘consumerKey’
);

/* Display API server timestamp */
var_dump( $api -> get( ‘/auth/time’ ) );

Code minimal APC PHPKOD

/*
* Les clés applicationKey et applicationSecret doivent être
* renseignées dans le fichier de configuration ou
* l'assistant du CMD AdminXtration avant d'appeler
* la fonction
*/
$api = Program::API();
/* Display API server timestamp */
var_dump( $api -> get( ‘/auth/time’ ) );

Connexion utilisateur OAuth

try{
   /* Get token from API */
   $credential = $api -> post( 
      '/auth/oauth/credential', 
      [callback=>'http://my.url.tld'] 
   );
   $_SESSION['token'] = $credential['token'];
   /* Redirect to login URL */
   header('location:'.$credential['url']);
} catch(Exception $e) {
   die(Login error : '.$e -> getMessage());
}
     

Echantillons de code pour jQuery

Square Works met à votre disposition une librairie Javascript écrite pour le framework jQuery 

Dès que vous avez obtenu votre clé d'application et votre clé secrète vous pouvez commencer à utiliser l'API.

 

 Télécharger le plugin jQuery
Fichier zip, 7ko
 

Inclure la librairie dans le header

<!script src="lib/apcapi.jquery.js">

Initialiser la classe ApcApi

$(function() {
$.ApcApi.init('[appKey]', '[appSecret]', '[token]', '[domaine]');
});

Informations sur la session

$.ApcApi.request('/auth/infos', {"callback":"http://my.url.tld"}) 
  .success(function(datas){ 
    console.log('Session expire on : '+datas.expiry);
  }) 
  .error(function(error){ 
    console.log('Error : '+error);
  }) 
  .post();
     

Echantillons de code pour Angular

Square Works met à votre disposition une librairie Javascript écrite pour le framework Angular 

Cette classe sera disponible dans le scope comme argument des fonctions.

Dès que vous avez obtenu votre clé d'application et votre clé secrète vous pouvez commencer à utiliser l'API.

 

 Télécharger la librairie Javascript
Fichier zip, 7ko
 

Inclure la librairie dans index.html

<!script src="js/ApcApi.js">

Initialiser dans le run du fichier app.js

.run(function($ionicPlatform, $rootScope, ApcApi) {
$ionicPlatform.ready(function() {
ApcApi.init('[appKey]', '[appSecret]');
});
})

Connexion utilisateur OAuth

ApcApi.request('/auth/oauth/credential', {"callback":"http://my.url.tld"}) 
  .success(function(datas){ 
    console.log('Must redirect to URL : '+datas.url);
  }) 
  .error(function(error){ 
    console.log('Error : '+error);
  }) 
  .post();
     

Echantillons de code pour ApcJs

Square Works met à votre disposition une librairie Javascript écrite pour le framework APC JS 

Dès que vous avez obtenu votre clé d'application et votre clé secrète vous pouvez commencer à utiliser l'API.

 

 Télécharger le plugin jQuery
Fichier zip, 7ko
 

Appeler la librairie

apc.lib('ApcApi', function(){
ApcApi.init('[appKey]', '[appSecret]');
});

Connexion utilisateur OAuth

ApcApi.request('/auth/oauth/credential', {"callback":"http://my.url.tld"}) 
  .success(function(datas){ 
    console.log('Must redirect to URL : '+datas.url);
  }) 
  .error(function(error){ 
    console.log('Error : '+error);
  }) 
  .post();