API REST del database Firebase

token di accesso

Supportato da tutti i tipi di richiesta. Autentica questa richiesta per consentire l'accesso ai dati protetti dalle regole di sicurezza del database Firebase Realtime. Consulta la documentazione sull'autenticazione REST per i dettagli.

curl 'https://[PROJECT_ID].firebaseio/users/jack/name.json?access_token=CREDENTIAL'

poco profondo

Si tratta di una funzionalità avanzata, progettata per aiutarti a lavorare con set di dati di grandi dimensioni senza dover scaricare tutto. Impostalo su true per limitare la profondità dei dati restituiti in una posizione. Se i dati nella posizione sono una primitiva JSON (stringa, numero o booleano), verrà semplicemente restituito il relativo valore. Se lo snapshot dei dati nella posizione è un oggetto JSON, i valori per ogni chiave verranno troncati a true .

curl 'https://[PROJECT_ID].firebaseio/.json?shallow=true'

Tieni presente che shallow non può essere combinato con altri parametri di query.

stampa

Formatta i dati restituiti nella risposta dal server.

curl 'https://[PROJECT_ID].firebaseio.com/users/jack/name.json?print=pretty'

curl -X PUT -d '{ "first": "Jack", "last": "Sparrow" }' \
  'https://[PROJECT_ID].firebaseio.com/users/jack/name.json?print=silent'

richiamare

Supportato solo da GET . Per effettuare chiamate REST da un browser Web tra domini, puoi utilizzare JSONP per racchiudere la risposta in una funzione di callback JavaScript. Aggiungi callback= per fare in modo che l'API REST racchiuda i dati restituiti nella funzione di callback specificata.

<script>
  function gotData(data) {
    console.log(data);
  }
</script>
<script src="https://[PROJECT_ID].firebaseio.com/.json?callback=gotData"></script>

formato

Se impostato su export , il server codificherà le priorità nella risposta.

curl 'https://[PROJECT_ID].firebaseio.com/.json?format=export'

scaricamento

Supportato solo da GET . Se desideri attivare il download di un file dei tuoi dati da un browser web, aggiungi download= . Ciò fa sì che il servizio REST aggiunga le intestazioni appropriate in modo che i browser sappiano che è necessario salvare i dati in un file.

curl 'https://[PROJECT_ID].firebaseio/.json?download=myfilename.txt'

tempo scaduto

Utilizzalo per limitare il tempo impiegato dalla lettura sul lato server. Se una richiesta di lettura non termina entro il tempo assegnato, termina con un errore HTTP 400. Ciò è particolarmente utile quando si prevede un piccolo trasferimento di dati e non si vuole aspettare troppo a lungo per recuperare un sottoalbero potenzialmente enorme. Il tempo di lettura effettivo potrebbe variare in base alle dimensioni dei dati e alla memorizzazione nella cache.

Specificare timeouts utilizzando il seguente formato: 3ms , 3s o 3min , con un numero e un'unità. Se non specificato verrà applicato il timeout massimo di 15min . Se il timeout non è positivo, o supera il massimo, la richiesta verrà rifiutata con un errore HTTP 400.

writeSizeLimit

Se specifichi unlimited , sono consentite scritture eccezionalmente grandi (con un carico utile fino a 256 MB), bloccando potenzialmente le richieste successive mentre il database elabora l'operazione corrente. Le scritture non possono essere annullate una volta raggiunto il server.

curl -X DELETE 'https://docs-examples.firebaseio.com/rest/delete-data.json?writeSizeLimit=medium'

Verrà visualizzato il seguente messaggio di errore se la scrittura è troppo grande:

Error: WRITE_TOO_BIG: Data to write exceeds the maximum size that can be modified with a single request.

Inoltre, puoi impostare il defaultWriteSizeLimit per l'intera istanza del database utilizzando la CLI di Firebase. Questo limite si applica a tutte le richieste, comprese quelle provenienti dagli SDK. I nuovi database vengono creati con defaultWriteSizeLimit impostato su large . Non puoi impostare defaultWriteSizeLimit su tiny utilizzando la CLI di Firebase.

firebase database:settings:set defaultWriteSizeLimit large

ordinato da

Consulta la sezione della guida sui dati ordinati per maggiori informazioni.

limite al primo, limite all'ultimo, inizio, fine, uguale a

Per ulteriori informazioni consultare la sezione della guida sul filtraggio dei dati .

Mettere

I dati con codifica JSON sono un oggetto con due chiavi: path e data . La chiave del percorso punta a una posizione relativa all'URL della richiesta. Il client dovrebbe sostituire tutti i dati in quella posizione nella sua cache con data .

toppa

I dati con codifica JSON sono un oggetto con due chiavi: path e data . La chiave del percorso punta a una posizione relativa all'URL della richiesta. Per ogni chiave in data , il client deve sostituire la chiave corrispondente nella sua cache con i dati per quella chiave nel messaggio.

mantenersi in vita

I dati per questo evento sono null . Non è richiesta alcuna azione.

Annulla

Alcuni errori imprevisti possono inviare un evento "cancel" e interrompere la connessione. La causa è descritta nei dati forniti per questo evento. Alcune potenziali cause sono le seguenti: 1. Le regole di sicurezza del database Firebase Realtime non consentono più una lettura nella posizione richiesta. La descrizione dei dati per questa causa è "Autorizzazione negata". 2. Una scrittura ha attivato uno streamer di eventi che ha inviato un albero JSON di grandi dimensioni che supera il nostro limite, 512 MB. I "dati" per questa causa sono "Il carico utile specificato è troppo grande, richiedi una posizione con meno dati".

autenticazione_revocata

I dati per questo evento sono una stringa che indica che la credenziale è scaduta. Questo evento viene inviato quando il parametro auth fornito non è più valido.