API: collegare app a database

Con le API di Libemax puoi collegare qualunque software, sito web, app iPhone/iPad e Android al tuo database su Libemax.

Per accedere alle API basta chiamare questa pagina:

https://tuonome.libemax.com/api/api.php

 

Secure Key

Per generare la propria chiave di sicurezza dedicata andare sulla voce My Account -> API che si trova nel menù in alto a destra.

In questa pagina si potrà creare il proprio security code cliccando su "Create new API secure code" e visualizzare tutti i log delle richieste eseguite.

Il codice dovrà essere inserito come primo parametro della variabile secure

https://tuonome.libemax.com/api/api.php?secure=xxxxx

 

Parametro Type

La variabile type accetta i seguenti valori:

  • get: effettua una SELECT nella tabella
  • set: effettua una INSERT nella tabella
  • update: effettua un UPDATE nella tabella
  • del: effettua una DELETE nella tabella

https://tuonome.libemax.com/api/api.php?secure=xxxxx&type=get

 

I nomi delle colonne e tabelle devono essere quelle indicate facendo click su "Visualizza nome db", quindi non sono accettati spazi, accenti e caratteri speciali.

Per esempio la colonna "Età dipendenti" sarà convertita in "eta_dipendenti".

Inoltre, le colonne ti tipo funzione non possono essere restituite.

GET - parametri

column: nome delle colonne da estrarre separate da virgole (obbligatorio)

column=nome,indirizzo,citta,prov,cap,stato

table: nome della tabella (obbligatorio)

table=clienti

limit: quanti record estrarre dalla tabella, utile per le paginazioni (facoltativo)

limit=2,2

order_by: ordina i dati estratti secondo la colonna indicata (facoltativo)

order_by=nome

where - where_val - where_operator: estrae i valori che hanno nella colonna indicata nella variabile where il valore uguale/maggiore/minore/... indicato nella variabile where_val, possibilità di indicare l'operatore in where_operator con i seguenti valori: like, equal, mag, min, magequal, minequal (facoltativo)

where=citta&where_val=Milano

between - between_from - between_to: estrae i valori che hanno nella colonna di tipo data e ora indicata nella variabile between i valori con data da between_from a between_to (facoltativo)

between=data_inizio&between_from=1016-10-01&between_to=2016-10-31

 

https://tuonome.libemax.com/api/api.php?secure=xxxxx&type=get&column=nome,indirizzo,citta,prov,cap,stato&table=clienti&limit=2,2&order_by=nome&where=citta&where_val=Milano

Massimo 50 record per ogni richiesta.

Risposta:

<root>
<records>
<record>
<id>4</id>
<nome><![CDATA[Cliente 1]]></nome>
<indirizzo><![CDATA[via prova, 23]]></indirizzo>
<citta><![CDATA[Bergamo]]></citta>
</record>
<record>
<id>5</id>
<nome><![CDATA[Cliente 2]]></nome>
<indirizzo><![CDATA[via test, 3]]></indirizzo>
<citta><![CDATA[Milano]]></citta>
</record>
<record>
...
</record>
</records>
<total_rows_table>
<num>3</num> // righe totali nella tabella
</total_rows_table>
</root>

 

SET - parametri

column_set: nome delle colonne da popolare, separate da virgole (obbligatorio)

column_set=nome,indirizzo,citta

valueXX: dati da inserire in ogni colonna (obbligatorio)

value1=Test&value2=prova,23&value3=Dalmine

table: nome della tabella in cui inserire i dati (obbligatorio)

table=clienti

 

https://tuonome.libemax.com/api/api.php?secure=xxxxx&type=set&column_set=nome,indirizzo,citta&value1=Test&value2=prova,23&value3=Dalmine&table=clienti

 

Risposta:

<root>
<result>Record inserted successfully</result>
<id>4</id> // ID del record appena inserito
</root>

 

 

UPDATE - parametri

column_update: nome delle colonne dei valori da modificare, separate da virgole (obbligatorio)

column_update=nome,indirizzo,citta

value_updateXX: dati da modificare in ogni colonna (obbligatorio)

value_update1=Test&value_update2=prova,23&value_update3=Dalmine

table: nome della tabella in cui modificare i dati (obbligatorio)

table=clienti

where_update - where_val_update: modifica i valori che hanno nella colonna indicata nella variabile where_update il valore uguale indicato nella variabile where_val_update (obbligatorio)

where_update=citta&where_val_update=Milano

 

https://tuonome.libemax.com/api/api.php?secure=xxxxx&type=update&column_update=nome,indirizzo&value_update1=Prova&value_update2=test,56&table=clienti&where_update=ID&where_val_update=5

 

Risposta:

<root>
<result>Record updated successfully</result>
</root>

 

DEL - parametri

delete: ID del record da eliminare (obbligatorio)

delete=4

table: nome della tabella da cui eliminare il record (obbligatorio)

table=clienti

 

https://tuonome.libemax.com/api/api.php?secure=xxxxx&type=del&table=clienti&delete=4

 

Risposta:

<root>
<result>Record deleted successfully</result>
</root>

 

Formato (XML e JSON)

Aggiungendo il parametro format è possibile impostare il formato di uscita dei dati.

Format: xml o json (default: xml)

 

Ogni utente ha 1000 API request GRATIS per iniziare ad utilizzare subito le API di Libemax.



Condividi su:

Google+ Facebook Twitter LinkedIn