API REST de base de datos de Firebase

token_acceso

Compatible con todo tipo de solicitudes. Autentica esta solicitud para permitir el acceso a los datos protegidos por las reglas de seguridad de la base de datos en tiempo real de Firebase. Consulte la documentación de autenticación REST para obtener más detalles.

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

poco profundo

Esta es una característica avanzada, diseñada para ayudarle a trabajar con grandes conjuntos de datos sin necesidad de descargarlo todo. Establezca esto en true para limitar la profundidad de los datos devueltos en una ubicación. Si los datos en la ubicación son una primitiva JSON (cadena, número o booleano), simplemente se devolverá su valor. Si la instantánea de datos en la ubicación es un objeto JSON, los valores de cada clave se truncarán a true .

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

Tenga en cuenta que shallow no se puede combinar con ningún otro parámetro de consulta.

imprimir

Formatea los datos devueltos 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'

llamar de vuelta

Compatible únicamente con GET . Para realizar llamadas REST desde un navegador web entre dominios, puede usar JSONP para encapsular la respuesta en una función de devolución de llamada de JavaScript. Agregue callback= para que la API REST incluya los datos devueltos en la función de devolución de llamada que especifique.

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

formato

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

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

descargar

Compatible únicamente con GET . Si desea activar una descarga de archivos de sus datos desde un navegador web, agregue download= . Esto hace que el servicio REST agregue los encabezados apropiados para que los navegadores sepan guardar los datos en un archivo.

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

se acabó el tiempo

Utilice esto para limitar el tiempo que tarda la lectura en el lado del servidor. Si una solicitud de lectura no finaliza dentro del tiempo asignado, finaliza con un error HTTP 400. Esto es particularmente útil cuando espera una pequeña transferencia de datos y no quiere esperar demasiado para recuperar un subárbol potencialmente enorme. El tiempo de lectura real puede variar según el tamaño de los datos y el almacenamiento en caché.

Especifique timeouts usando el siguiente formato: 3ms , 3s o 3min , con un número y una unidad. Si no se especifica, se aplicará el timeout máximo de 15min . Si el timeout no es positivo o excede el máximo, la solicitud será rechazada con un error HTTP 400.

escribirTamañoLimit

Si especifica unlimited , se permiten escrituras excepcionalmente grandes (con una carga útil de hasta 256 MB), lo que podría bloquear solicitudes posteriores mientras la base de datos procesa la 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'

Verá el siguiente mensaje de error si la escritura es demasiado grande:

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

Además, puede configurar defaultWriteSizeLimit para toda la instancia de la base de datos mediante Firebase CLI. Este límite se aplica a todas las solicitudes, incluidas las de SDK. Las nuevas bases de datos se crean con defaultWriteSizeLimit establecido en large . No puedes configurar defaultWriteSizeLimit en tiny usando Firebase CLI.

firebase database:settings:set defaultWriteSizeLimit large

ordenar por

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

límiteParaPrimero, límiteParaÚltimo, inicioEn, finEn, igualA

Consulte la sección de la guía sobre filtrado de datos para obtener más información.

poner

Los datos codificados en JSON son un objeto con dos claves: ruta y datos . La clave de ruta apunta a una ubicación relativa a la URL de solicitud. El cliente debe reemplazar todos los datos en esa ubicación en su caché con datos .

parche

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

mantener viva

Los datos de este evento son null . No se requiere ninguna acción.

Cancelar

Algunos errores inesperados pueden enviar un evento de "cancelación" y finalizar la conexión. La causa se describe en los datos proporcionados para este evento. Algunas causas potenciales son las siguientes: 1. Las reglas de seguridad de la base de datos en tiempo real de Firebase ya no permiten una lectura en la ubicación solicitada. La descripción de los "datos" para esta causa es "Permiso denegado". 2. Una escritura desencadenó un transmisor de eventos que envió un árbol JSON grande que excede nuestro límite, 512 MB. Los "datos" para esta causa son "La carga útil especificada es demasiado grande; solicite una ubicación 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 parámetro auth proporcionado ya no es válido.