La API de Instance ID está obsoleta. Si necesitas acceder a identificadores únicos de instalación de apps, usa la API de Firebase installations. Consulta también Instalaciones de Firebase y el ID de instancia.

Referencia del servidor

La implementación del servidor es opcional. Usa el servicio de Instance ID si deseas realizar estas operaciones:

Obtener información sobre las instancias de la app. Verificar los tokens de la app o obtener más información sobre la instancia de la app que creó el token
Crear mapas de relaciones para las instancias de la app. Crear relaciones entre las instancias de la app y las entidades
Crear tokens de registro para los tokens de APNs. Esta API te permite importar en masa los tokens de APNs existentes y asignarlos a tokens de registro válidos para FCM

Obtén información sobre las instancias de la app

Para obtener información sobre una instancia de la app, llama al servicio de Instance ID en este extremo y proporciona el token de la instancia de la app como se muestra a continuación:

 https://iid.googleapis.com/iid/info/IID_TOKEN

Parámetros

Authorization: Bearer <access_token>. Establece este parámetro en el encabezado. Agrega un token de OAuth2 de corta duración como el valor del encabezado Authorization. Para obtener más información sobre cómo obtener este token, consulta Proporciona credenciales de forma manual.
access_token_auth: true. Establece este parámetro en el encabezado.
[opcional] booleano details: Establece este parámetro de consulta en true para obtener información sobre la suscripción al tema de FCM (si corresponde) asociada con este token. Cuando no se especifica, el valor predeterminado es false.

Resultados

Si la operación se realiza correctamente, la llamada devuelve el estado HTTP 200 y un objeto JSON que contiene lo siguiente:

application - Es el nombre del paquete asociado con el token.
authorizedEntity: Es el projectId autorizado para enviar al token.
applicationVersion: Es la versión de la aplicación.
platform - devuelve ANDROID, IOS o CHROME para indicar la plataforma del dispositivo al que pertenece el token.

Si se establece la marca details, se devuelve lo siguiente:

rel - Son las relaciones asociadas con el token. Por ejemplo, una lista de suscripciones a temas.

Ejemplo de solicitud `GET`

https://iid.googleapis.com/iid/info/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true

Resultado de ejemplo

HTTP 200 OK
{
  "application":"com.iid.example",
  "authorizedEntity":"123456782354",
  "platform":"Android",
  "rel":{
    "topics":{
      "topicname1":{"addDate":"2015-07-30"},
      "topicname2":{"addDate":"2015-07-30"},
      "topicname3":{"addDate":"2015-07-30"},
      "topicname4":{"addDate":"2015-07-30"}
    }
  }
}

Crea mapas de relaciones para las instancias de la app

La API de Instance ID te permite crear mapas de relaciones para las instancias de la app. Por ejemplo, puedes asignar un token de registro a un tema de FCM y suscribir la instancia de la app al tema. La API proporciona métodos para crear esas relaciones de forma individual y masiva.

Crea una asignación de relación para una instancia de app

Dado un token de registro y una relación admitida, puedes crear una asignación. Por ejemplo, puedes suscribir una instancia de la app a un tema de FCM llamando al servicio de Instance ID en este extremo y proporcionando el token de la instancia de la app como se muestra a continuación:

 https://iid.googleapis.com/iid/v1/IID_TOKEN/rel/topics/TOPIC_NAME

Parámetros

Authorization: Bearer <access_token>. Establece este parámetro en el encabezado. Agrega un token de OAuth2 de corta duración como el valor del encabezado Authorization. Para obtener más información sobre cómo obtener este token, consulta Proporciona credenciales de forma manual.
access_token_auth: true. Establece este parámetro en el encabezado.

Resultados

Si la operación se realiza correctamente, la llamada devuelve el estado HTTP 200.

Ejemplo de solicitud `POST`

https://iid.googleapis.com/iid/v1/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA/rel/topics/movies
Content-Type:application/json
Content-Length: 0
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true

Resultado de ejemplo

HTTP 200 OK
{}

Administra asignaciones de relación para varias instancias de app

Con los métodos por lotes del servicio de Instance ID, puedes realizar la administración por lotes de las instancias de la app. Por ejemplo, puedes agregar o quitar instancias de la app de forma masiva a un tema de FCM. Para actualizar hasta 1, 000 instancias de la app por llamada a la API, llama al servicio de Instance ID en este extremo y proporciona los tokens de la instancia de la app en el cuerpo JSON:

 https://iid.googleapis.com/iid/v1:batchAdd

 https://iid.googleapis.com/iid/v1:batchRemove

Parámetros

Authorization: Bearer <access_token>. Establece este parámetro en el encabezado. Agrega un token de OAuth2 de corta duración como el valor del encabezado Authorization. Para obtener más información sobre cómo obtener este token, consulta Proporciona credenciales de forma manual.
access_token_auth: true. Establece este parámetro en el encabezado.
to : Es el nombre del tema.
registration_tokens : Es el array de tokens de IID para las instancias de la app que deseas agregar o quitar.

Resultados

Si la operación se realiza correctamente, la llamada devuelve el estado HTTP 200. Los resultados vacíos indican que la suscripción al token se realizó correctamente. En el caso de las suscripciones fallidas, el resultado contiene uno de estos códigos de error:

NOT_FOUND: Se borró el token de registro o se desinstaló la app.
INVALID_ARGUMENT: El token de registro proporcionado no es válido para el ID del remitente.
INTERNAL: El servidor de backend falló por motivos desconocidos. Reintenta la solicitud.
TOO_MANY_TOPICS: Cantidad excesiva de temas por instancia de la app.
RESOURCE_EXHAUSTED: Demasiadas solicitudes de suscripción o cancelación de suscripción en un período breve. Volver a intentarlo con una retirada exponencial

Ejemplo de solicitud `POST`

https://iid.googleapis.com/iid/v1:batchAdd
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true
{
   "to": "/topics/movies",
   "registration_tokens": ["nKctODamlM4:CKrh_PC8kIb7O...", "1uoasi24:9jsjwuw...", "798aywu:cba420..."],
}

Resultado de ejemplo

HTTP 200 OK
{
  "results":[
    {},
    {"error":"NOT_FOUND"},
    {},
  ]
}

Crea tokens de registro para los tokens de APNs

Con el método batchImport del servicio de Instance ID, puedes importar en masa los tokens de APNs de iOS existentes a Firebase Cloud Messaging y asignarlos a tokens de registro válidos. Llama al servicio de Instance ID en este extremo y proporciona una lista de tokens de APNs en el cuerpo JSON:

 https://iid.googleapis.com/iid/v1:batchImport

El cuerpo de la respuesta contiene un array de tokens de registro de Instance ID listos para usarse para enviar mensajes de FCM al token de dispositivo de APNs correspondiente.

Parámetros

Authorization: Bearer <access_token>. Establece este parámetro en el encabezado. Agrega un token de OAuth2 de corta duración como el valor del encabezado Authorization. Para obtener más información sobre cómo obtener este token, consulta Proporciona credenciales de forma manual.
access_token_auth: true. Establece este parámetro en el encabezado.
application : Es el ID del paquete de la app.
sandbox : Es un valor booleano para indicar el entorno de zona de pruebas (TRUE) o de producción (FALSE).
apns_tokens : Es el array de tokens de APNs para las instancias de la app que deseas agregar o quitar. Máximo de 100 tokens por solicitud.

Resultados

Si la operación se realiza correctamente, la llamada devuelve el estado HTTP 200 y un cuerpo de resultado JSON. Para cada token de APNs proporcionado en la solicitud, la lista de resultados incluye lo siguiente:

El token de APNs
Estado Ya sea OK o un mensaje de error que describa la falla
Para obtener resultados correctos, el token de registro que FCM asigna al token de APNs

Ejemplo de solicitud `POST`

https://iid.googleapis.com/iid/v1:batchImport
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth:true
{
  "application": "com.google.FCMTestApp",
  "sandbox":false,
  "apns_tokens":[
      "368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
      "76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86"
   ]
}

Resultado de ejemplo

HTTP 200 OK
{
 "results":[
       {
        "apns_token": "368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
         "status": "OK",
         "registration_token":"nKctODamlM4:CKrh_PC8kIb7O...clJONHoA"
       },
       {
         "apns_token": "76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86",
         "status":"Internal Server Error"
        },
     ]
  }

Respuestas de error

Las llamadas a la API del servidor de Instance ID devuelven los siguientes códigos de error HTTP:

HTTP status 400 (Bad request): Faltan los parámetros de la solicitud o no son válidos. Consulta los mensajes de error para obtener información detallada.
HTTP status 401 (Unauthorized): El encabezado de autorización no es válido.
HTTP status 403 (Forbidden) - El encabezado de autorización no coincide con el authorizedEntity.
HTTP status 404 (Not found) - No se encontró la ruta de acceso HTTP no válida o el token de IID. Consulta los mensajes de error para obtener información detallada.
HTTP status 503 (Service unavailable): El servicio no está disponible. Reintenta la solicitud con una retirada exponencial.

Referencia del servidor Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Obtén información sobre las instancias de la app

Parámetros

Resultados

Ejemplo de solicitud GET

Resultado de ejemplo

Crea mapas de relaciones para las instancias de la app

Crea una asignación de relación para una instancia de app

Parámetros

Resultados

Ejemplo de solicitud POST

Resultado de ejemplo

Administra asignaciones de relación para varias instancias de app

Parámetros

Resultados

Ejemplo de solicitud POST

Resultado de ejemplo

Crea tokens de registro para los tokens de APNs

Parámetros

Resultados

Ejemplo de solicitud POST

Resultado de ejemplo

Respuestas de error

Referencia del servidor

Ejemplo de solicitud `GET`

Ejemplo de solicitud `POST`

Ejemplo de solicitud `POST`

Ejemplo de solicitud `POST`