Guide di integrazione › Guida di riferimento API del servizio Web › Sintassi generica dell'API

Sintassi generica dell'API

Per avviare una richiesta API per un oggetto, utilizzare il comando con il seguente formato

GET "http://ws-ip/api/v1/obj/method?arg1=<value>&arg2=<value>&vdc=<grid>"

In cui:: ws-ip è l'indirizzo IP utilizzato per accedere all'applicazione 'WS_API'
object è un oggetto API come ad esempio app, class, e così via.
method è l'azione da eseguire per l'oggetto come ad esempio avviare, interrompere, e così via.
arg1, arg2 sono gli argomenti da trasferire al metodo
vdc è il nome del controller della griglia
note

Sintassi dell'opzione con valori: un'opzione con valori è generalmente espressa nel formato seguente:
```
<property_name>=<value>
```
Il valore deve avere una codifica URI (codifica tramite percentuale dell'Uniform Resource Identifier), secondo le regole specifiche del componente percorso dell'URI. Sostituire qualsiasi carattere riservato per il campo percorso di un URI, quale percentuale, spazio e tabulazione, uguale, virgola, barra, punto interrogativo e virgolette singole e doppie, con la sua versione codificata tramite percentuale %HH, in cui l'HH è la rappresentazione ASCII esadecimale per il carattere considerato.

Nota: consultare RFC 3986 per dettagli sulla codifica URI.

Sintassi del flag di opzione: benché la CLI utilizzi un trattino doppio o l'em-dash (—) come prefisso per designare un flag di opzione (generalmente un'opzione senza un valore), l'API dei servizi Web utilizza ancora la e commerciale (&) come prefisso. Perciò, se nella CLI risulta --option, i servizi Web utilizzeranno invece &option. Ad esempio, se nella CLI è presente --debug, l'API dei servizi Web utilizzerà &debug.
Benché le descrizioni delle richieste dell'API per un oggetto includano tutti i parametri obbligatori, esse includono solo alcuni dei parametri facoltativi. I parametri facoltativi non inclusi in questa guida vengono descritti nella Guida di riferimento della shell della riga di comando.

Esempio:

Ottenere i metodi per l'oggetto app
curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid

Output di esempio:

{
   "method" : [
      {
         "name" : "config"
      },
      {
         "name" : "copy"
      },
      {
         "name" : "create"
      },
      {
         "name" : "destroy"
      },
      .
      .
      .
   ]
}

Formati di output

I formati di output accettabili sono XML o JSON. Questi possono essere specificati nella richiesta API.

Esempio:

Ottenere i metodi per l'oggetto app in formato XML.

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/xml"

Ottenere i metodi per l'oggetto app in formato JSON.

curl http://192.168.123.200/api/v1/obj/info?obj=app&vdc=mygrid -H "Accept: application/json"

Nota: tutti gli output in JSON sono codificati UTF8. Utilizzare una decodifica UTF8 per decodificare l'output codificato UTF8. Di seguito è riportato un esempio di un semplice script PHP per decodificare un output JSON codificato UTF8:

<? 
$json = '{"a": "\u00e3\u0081\u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

Questa sezione contiene i seguenti argomenti:

Tipi di argomento comuni

È possibile utilizzare il seguente tipo di argomento generico che è comune a molti comandi. Quando in una descrizione di un particolare comando si fa riferimento a un tipo di argomento specifico, utilizzare le seguenti informazioni dettagliate per il tipo considerato.

<principal>

<principal> rappresenta una persona, sia un individuo che un gruppo, di un dato ambito, locale o globale. Specificare un entità principale secondo una delle sintassi possibili seguenti:

<name>: Utente o gruppo locale.
/<name>: Utente o gruppo globale.
<scope>:<type>:<name>: Un nome completo dell'entità principale in cui <scope> è globale o locale, <type> è gruppo o utente e <name> è il nome utente o del gruppo.

Nota: un'entità principale deve avere una codifica URL. Ad esempio: local:user:api@3tera.com dovrebbe essere utilizzato come local%3Auser%3Aapi%403tera.com