API de REST de Firebase Database

access_token

Es compatible con todos los tipos de solicitud. Autentica esta solicitud para permitir acceso a los datos protegidos por Firebase Realtime Database Security Rules. Consulta el Documentación de autenticación de REST para obtener más detalles

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

shallow

Se trata de una función avanzada, diseñada para ayudarte a trabajar con modelos conjuntos de datos sin tener que descargarlo todo. Establecer como true para limitar la profundidad de los datos que se muestran en una ubicación. Si los datos en la ubicación son un primitivo de JSON (cadena, número o booleano), su valor simplemente se devolverá. Si el botón instantánea de datos en la ubicación es un objeto JSON, el los valores de cada clave se truncarán a true.

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

Ten en cuenta que shallow no se puede combinar con ninguna otra consulta parámetros.

print

Da formato a los datos que se muestran en la respuesta del servidor.

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'

callback

Solo es compatible con GET. Realizar llamadas de REST desde un navegador web entre dominios, puedes usar JSONP para unir la respuesta en un código función de devolución de llamada. Agrega callback= para unir la API de REST los datos devueltos en la función de devolución de llamada que especifiques.

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

formato

Si se establece en export, el servidor codificará las prioridades en la respuesta.

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

descarga

Solo es compatible con GET. Si quieres activar un archivo descarga de datos de un navegador web, agrega download=. Esto hace que el servicio de REST agregue los encabezados adecuados para que los navegadores saben que deben guardar los datos en un archivo.

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

tiempo de espera agotado

Úsalo para limitar el tiempo que tarda la lectura en el servidor. Si una operación de lectura no finaliza en el tiempo asignado, termina con una solicitud error 400. Esto es muy útil cuando esperas que la transferencia de datos sea pequeña y no queremos esperar demasiado para recuperar un subárbol potencialmente enorme. Real el tiempo de lectura puede variar según el tamaño de los datos y el almacenamiento en caché.

Especifica timeouts con el siguiente formato: 3ms. 3s o 3min, con un número y una unidad. Si no es así especificado, la timeout máxima de 15min será se aplicó. Si el valor de timeout no es positivo o excede el máximo, la solicitud se rechazará con un error HTTP 400.

writeSizeLimit

Si especificas unlimited, escrituras excepcionalmente grandes (con carga útil de hasta 256 MB) están permitidos, lo que podría bloquear las solicitudes posteriores mientras la base de datos procesa el operación actual. Las escrituras no se pueden cancelar una vez que llegan al servidor.

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

Si la escritura es demasiado grande, verás el siguiente mensaje de error:

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

Además, puedes configurar el defaultWriteSizeLimit para toda la base de datos. con Firebase CLI. Este límite se aplica a todas las solicitudes, incluidas las que provienen de SDKs. Se crean bases de datos nuevas con defaultWriteSizeLimit establecido en large. No puedes configurar defaultWriteSizeLimit como tiny con Firebase CLI.

firebase database:settings:set defaultWriteSizeLimit large

orderBy

Consulta la sección en la guía sobre datos ordenados para obtener más información.

limitToFirst, limitToLast, startAt, endAt, equalTo

Consulta la sección en la guía sobre filtrar datos para más información.

put

Los datos con codificación JSON son un objeto con dos claves: path y datos. La clave path apunta a una en relación con la URL de la solicitud. El cliente debe reemplazar todos los datos que se encuentran en esa ubicación en su caché con data.

patch

Los datos con codificación JSON son un objeto con dos claves: path y datos. La clave path apunta a una en relación con la URL de la solicitud. Para cada clave en data, el cliente debe reemplazar el correspondiente en su caché con los datos de esa clave en el mensaje.

keep-alive

Los datos de este evento son null. No es necesario que realices ninguna acción.

cancelar

Algunos errores inesperados pueden enviar un evento "cancel" y finalizar la conexión. La causa se describe en los datos proporcionados para este evento. Algunas causas potenciales son las siguientes: sigue: 1) Firebase Realtime Database Security Rules ya no permite una lectura en la ubicación solicitada. El La descripción "data" de esta causa es "Permiso denegado". 2. Una operación de escritura activó un transmisor de eventos que envió un gran árbol JSON que supera nuestro límite. 512MB. El `data` para esta causa es "La carga útil especificada es demasiado grande. Solicita una con menos datos".

auth_revoked

Los datos de este evento son una cadena que indica que la credencial ha caducado. Este evento se envía cuando el elemento auth proporcionado ya no es válido.