Guida OData API di Claris FileMaker

Il Protocollo Open Data (OData) è un'implementazione API conforme agli standard industriali che fornisce un metodo standard per interrogare e aggiornare i dati, permettendo ai client API REST di accedere ai dati FileMaker ospitati da FileMaker Cloud e FileMaker Server. OData utilizza l'architettura REST (REpresentational State Transfer) ed è quindi un'API REST. OData è simile alle tecnologie Open Database Connectivity (ODBC) e Java Database Connectivity (JDBC) poiché fornisce alle applicazioni di terze parti, come Excel, un metodo standard per accedere ai dati FileMaker. Vedere Protocollo OData 4.01 (in Inglese).

Inoltre, OData restituisce i dati in formato JSON (JavaScript Object Notation) e Atom (Atom Syndication Format). JSON è un formato di testo comunemente utilizzato con API REST poiché è compatto e leggibile. Atom è un formato XML utilizzato per creare e aggiornare le risorse Web ed è supportato per le applicazioni che utilizzano dati in una struttura XML invece che JSON.

Importante   FileMaker OData API sta progressivamente raggiungendo la conformità a OData 4.01. Le seguenti caratteristiche sono conformi:

  • Il formato JSON OData

  • Supporto di varianti di intestazione e di valori di preferenza sia con prefisso che senza prefisso

  • Rifiuto di richieste con opzioni di query di sistema $schemaversion incompatibili, se le annotazioni Core.SchemaVersion vengono restituite in $metadata

  • Supporto della specifica delle opzioni di query di sistema con o senza il prefisso "$"

  • Supporto di nomi di opzioni di query, operatori e funzioni canoniche senza distinzione tra maiuscole e minuscole

  • Restituzione degli identificatori se sono specificati in $metadata

Questa guida suppone che l'utente abbia esperienza con:

  • utilizzo di FileMaker Pro per creare i database. È necessario comprendere le nozioni di base della progettazione dei database FileMaker Pro e i concetti di campo, tabella, relazione e contenitore. Vedere la Guida di FileMaker Pro.

  • utilizzo di FileMaker Server o FileMaker Cloud per ospitare i database. È necessario comprendere come configurare l'host, consentire l'accesso ai database ospitati e monitorare i database ospitati utilizzando l'Admin Console.

    Vedere la documentazione dei prodotti FileMaker Cloud e FileMaker Server nel Centro documentazione prodotto.

  • utilizzo di API REST in applicazioni lato server o servizi Web che chiamano i metodi POST, GET, PATCH e DELETE.