Client PHP de l'API de guifi.net

Descàrrega

Descarrega els fitxers del client PHP de l'API de guifi.net.

En aquest arxiu comprimit s'hi poden trobar diversos fitxers d'exemples d'ús del client.

PHPDoc

Es pot trobar la documentació generada pel PHPDocumentator del client PHP a phpdoc/

Posada a punt

El funcionament bàsic del client és molt simple.

<?php
  $username = ""; // Nom del teu usuari de guifi.net
  $password = ""; // Contrasenya del teu usuari de guifi.net
  $gapi = new guifiAPI( $username, $password );
?>

Exemples d'ús

Gestionar zones

El codi bàsic per afegir una zona nova és:

<?php
  $title = "Sant Jaume de Frontanyà"; // Nom de la zona
  $parent_zone = 4176; // Zona pare
  $min_lat = '42.183122730364815'; // Latitud de l'escaire SO de la zona
  $min_lon = '2.0180511474609375'; // Longitud de l'escaire SO de la zona
  $max_lat = '42.19139028706819'; // Latitud de l'escaire NE de la zona
  $max_lon = '2.0276641845703125'; // Longitud de l'escaire NE de la zona
	
  $gapi->addZone( $title, $parent_zone, $min_lat, $min_lon, $max_lat, $max_lon, $max_lat );
?>

Es pot trobar un exemple més complet a examples.guifi_api.zone.phps.

Gestionar nodes

El codi bàsic per afegir un node nou és:

<?php
  $title = "Plaça Major, 34"; // Nom del node
  $parent_zone = 27182; // Zona pare
  $lat = '42.187065853813635'; // Latitud del node
  $lon = '2.0233726501464844'; // Longitud del node
	
  $gapi->addNode( $title, $parent_zone, $lat, $lon );
?>

Es pot trobar un exemple més complet a examples.guifi_api.node.phps.

Gestionar dispositius

El codi bàsic per afegir un dispositiu nou és:

<?php
  $node_id = 27187;
  $type = 'radio';
  $mac = 'AB:CD:EF:AB:CD:EF';
	
  $gapi->addDevice( $node_id, $type, $mac );
?>

Es pot trobar un exemple més complet a examples.guifi_api.device.phps.

Gestionar ràdios

El codi bàsic per afegir un dispositiu nou és:

<?php
  $mode = "ap";
  $device_id = 19534;
  $mac = 'AA:BB:CC:DD:EE:FF';
	
  $gapi->addRadio( $mode, $device_id, $mac );
?>

Es pot trobar un exemple més complet a examples.guifi_api.radio.phps.

Gestionar Interfícies

El codi bàsic per afegir una interfície a una ràdio (en mode AP) és:

<?php
  $device_id = 19534;
  $radiodev_counter = 1;
	
  $gapi->addInterface( $device_id, $radiodev_counter );
?>

Es pot trobar un exemple més complet a examples.guifi_api.interface.phps.

Gestionar enllaços

El codi bàsic per afegir un enllaç a una ràdio és:

<?php
  $from_device_id = 19534;
  $from_radiodev_counter = 1;
  $to_device_id = 10018;
  $to_radiodev_counter = 0;
	
  $gapi->addLink( $from_device_id, $from_radiodev_counter, $to_device_id, $to_radiodev_counter );
?>

Es pot trobar un exemple més complet a examples.guifi_api.link.phps.

Miscel·lània

Hi ha també un seguit d'altres mètodes que també es poden utilitzar dins de l'API de guifi.net.

Es pot trobar un exemple complet de com utilitzar aquests mètodes a examples.guifi_api.misc.php

Exemple complet

Finalment, hi ha un exemple complet de mashup per afegir nodes client molt fàcilment.

L'exemple es composa de tres fitxers ([1], [2], [3]), i encara que és una aplicació molt simple serveix per veure el potencial que té l'API de guifi.net per crear noves aplicacions.