API de administración de Firebase

La API de administración de Firebase habilita la configuración y la administración programática de los proyectos de Firebase, incluidos los recursos y las apps de Firebase de un proyecto.

Flujo de trabajo: Cómo configurar un proyecto de Firebase con el uso de la API de REST

Para la configuración programática de un FirebaseProject, deberás agregar los recursos y las apps de Firebase a un Project de Google Cloud Platform (GCP) existente. Si aún no tienes un Project de GCP existente, puedes crear uno mediante la API de GCP Resource Manager.

Para configurar un proyecto de Firebase, llama a los extremos de REST en el siguiente orden:

  1. Busca el nombre de recurso del Project de GCP existente al que deseas agregar los recursos de Firebase. Para ello, llama a availableProjects.list.

    Usa este identificador único (por ejemplo, projects/my-project-123) en llamadas posteriores.

  2. Llama a projects.addFirebase para agregar recursos de Firebase al Project de GCP.

    1. Para esta llamada, especifica todos los campos en el cuerpo de la solicitud.
    2. Para llamar a projects.addFirebase, los miembros deben tener las funciones de Editor o Propietario en el Project de GCP existente.
  3. Agrega una app a tu FirebaseProject, como se indica a continuación:

    • Si quieres agregar una app para iOS, llama a projects.iosApps.create.

      Para esta llamada, especifica name, displayName y bundleId en el cuerpo de la solicitud.

    • Si quieres agregar una app para Android, llama a projects.androidApps.create.

      Para esta llamada, especifica name, displayName y packageName en el cuerpo de la solicitud.

      • Agrega certificados SHA a tu app para Android mediante una llamada a projects.androidApps.sha.create.

        Para esta llamada, el campo name del cuerpo de la solicitud debe estar vacío.

A fin de obtener información sobre la administración de acceso programático para estas llamadas, visita la documentación de la API de Cloud Identity Access Management (IAM).

Servicio: firebase.googleapis.com

Todos los URI que aparecen a continuación se relacionan con https://firebase.googleapis.com

Este servicio proporciona los siguientes documentos de descubrimiento:

Recurso de REST: v1beta1.availableProjects

Métodos
list GET /v1beta1/availableProjects
Muestra una lista de los Projects de Google Cloud Platform (GCP) que están disponibles para que se les agreguen los recursos de Firebase.

Recurso de REST: v1beta1.projects

Métodos
addFirebase POST /v1beta1/{project=projects/*}:addFirebase
Agrega recursos de Firebase al Project de Google Cloud Platform (GCP) existente que se especificó.
get GET /v1beta1/{name=projects/*}
Obtiene el FirebaseProject identificado mediante el nombre del recurso especificado.
getAdminSdkConfig GET /v1beta1/{name=projects/*/adminSdkConfig}
Obtiene el artefacto de configuración que utilizan los servidores para simplificar la inicialización.
list GET /v1beta1/projects
Enumera cada FirebaseProject al que puede acceder el emisor.
patch PATCH /v1beta1/{project.name=projects/*}
Actualiza los atributos del FirebaseProject que se identifica mediante el nombre del recurso especificado.
searchApps GET /v1beta1/{parent=projects/*}:searchApps
Un método práctico que enumera todas las apps disponibles para el FirebaseProject especificado.

Recurso de REST: v1beta1.projects.androidApps

Métodos
create POST /v1beta1/{parent=projects/*}/androidApps
Solicita que se cree una AndroidApp nueva.
get GET /v1beta1/{name=projects/*/androidApps/*}
Obtiene la AndroidApp identificada mediante el nombre del recurso especificado.
getConfig GET /v1beta1/{name=projects/*/androidApps/*/config}
Obtiene el artefacto de configuración asociado con la AndroidApp especificada.
list GET /v1beta1/{parent=projects/*}/androidApps
Enumera cada AndroidApp asociada con el proyecto principal especificado.
patch PATCH /v1beta1/{app.name=projects/*/androidApps/*}
Actualiza los atributos de la AndroidApp que se identifica mediante el nombre del recurso especificado.

Recurso de REST: v1beta1.projects.androidApps.sha

Métodos
create POST /v1beta1/{parent=projects/*/androidApps/*}/sha
Agrega un certificado SHA a la AndroidApp especificada.
delete DELETE /v1beta1/{name=projects/*/androidApps/*/sha/*}
Quita un certificado SHA de la AndroidApp especificada.
list GET /v1beta1/{parent=projects/*/androidApps/*}/sha
Muestra la lista de los certificados SHA-1 y SHA-256 de la AndroidApp especificada.

Recurso de REST: v1beta1.projects.iosApps

Métodos
create POST /v1beta1/{parent=projects/*}/iosApps
Solicita que se cree una IosApp nueva.
get GET /v1beta1/{name=projects/*/iosApps/*}
Obtiene la IosApp identificada mediante el nombre del recurso especificado.
getConfig GET /v1beta1/{name=projects/*/iosApps/*/config}
Obtiene el artefacto de configuración asociado con la IosApp especificada.
list GET /v1beta1/{parent=projects/*}/iosApps
Enumera cada IosApp asociada con el proyecto principal especificado.
patch PATCH /v1beta1/{app.name=projects/*/iosApps/*}
Actualiza los atributos de la IosApp que se identifica mediante el nombre del recurso especificado.

Servicio: firebase.googleapis.com

Todos los URI que aparecen a continuación se relacionan con https://firebase.googleapis.com

Este servicio proporciona los siguientes documentos de descubrimiento:

Recurso de REST: v1.operations

Métodos
cancel POST /v1/{name=operations/**}:cancel
Inicia la cancelación asincrónica en una operación de larga duración.
delete DELETE /v1/{name=operations/**}
Elimina una operación de larga duración.
get GET /v1/{name=operations/**}
Obtiene el último estado de una operación de larga duración.
list GET /v1/{name}
Enumera las operaciones que coinciden con el filtro especificado en la solicitud.

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.