A API Instance ID foi descontinuada. Caso você precise acessar identificadores exclusivos de instalação de apps, use a API de instalações do Firebase. Consulte também Instalações do Firebase e ID da instância.

Esta página foi traduzida pela API Cloud Translation.

Referência do servidor

A implementação do servidor é opcional. Use o serviço de ID da instância se quiser para realizar essas operações:

Receba informações sobre instâncias de apps. Verifique os tokens do aplicativo ou veja mais informações sobre a instância do aplicativo que criou o token.
Criar mapas de relacionamento para instâncias de apps. Criar relações entre instâncias e entidades do app.
Crie tokens de registro para tokens de APNs. Essa API permite importar em massa tokens de APNs existentes, mapeando-os para tokens de registro válidos para o FCM.

Receber informações sobre instâncias de apps

Para acessar informações sobre uma instância de aplicativo, chame o serviço de ID de instância em endpoint, fornecendo o token da instância do app, conforme mostrado abaixo:

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

Parâmetros

Authorization: Bearer <access_token>: Defina esse parâmetro no cabeçalho. Adicione um token OAuth2 de curta duração como o valor do cabeçalho Authorization. Para mais informações sobre como conseguir esse token, consulte Fornecer credenciais manualmente.
access_token_auth: true: Defina esse parâmetro no cabeçalho.
[opcional] booleano details: defina esse parâmetro de consulta como true para acessar o FCM. informações de assinatura de tópico (se houver) associadas a esse token. Quando não especificado, o padrão é false.

Resultados

Se for bem-sucedida, a chamada retornará o status HTTP 200 e um objeto JSON contendo:

application: nome do pacote associado ao token.
authorizedEntity: projectId autorizado a enviar para o token.
applicationVersion: versão do aplicativo.
platform: retorna ANDROID, IOS ou CHROME para indicar o dispositivo. plataforma à qual o token pertence.

Se a sinalização details estiver definida:

rel: relações associadas ao token. Por exemplo, uma lista de tópicos assinaturas.

Exemplo de solicitação `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

Exemplo de resultado

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"}
    }
  }
}

Criar mapas de relacionamento para instâncias de apps

Com a API Instance ID, é possível criar mapas de relacionamento para instâncias de apps. Por exemplo, você pode mapear um token de registro para um tópico do FCM, inscrever a instância do app no tópico. A API fornece métodos para criar essas relações individualmente e em massa.

Criar um mapeamento de relação para uma instância de app

Com um token de registro e uma relação compatível, é possível criar um mapeamento. Por exemplo, é possível inscrever uma instância de app em um tópico do FCM chamando o serviço de ID da instância endpoint, fornecendo o token da instância do app, conforme mostrado abaixo:

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

Parâmetros

Authorization: Bearer <access_token>: Defina esse parâmetro no cabeçalho. Adicione um token OAuth2 de curta duração como o valor do cabeçalho Authorization. Para mais informações sobre como conseguir esse token, consulte Fornecer credenciais manualmente.
access_token_auth: true: Defina esse parâmetro no cabeçalho.

Resultados

Se for bem-sucedida, a chamada retornará o status HTTP 200.

Exemplo de solicitação `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

Exemplo de resultado

HTTP 200 OK
{}

Gerenciar mapas de relacionamento para várias instâncias de app

Com os métodos em lote do serviço de ID da instância, é possível executar o gerenciamento de instâncias de apps. Por exemplo, é possível realizar transações em massa adição ou remoção de instâncias do app para um tópico do FCM. Para atualizar até mil instâncias do app por chamada de API, chame o ID da instância. neste endpoint, fornecendo os tokens de instância do app no corpo JSON:

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

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

Parâmetros

Authorization: Bearer <access_token>: Defina esse parâmetro no cabeçalho. Adicione um token OAuth2 de curta duração como o valor do cabeçalho Authorization. Para mais informações sobre como conseguir esse token, consulte Fornecer credenciais manualmente.
access_token_auth: true: Defina esse parâmetro no cabeçalho.
to : o nome do tópico.
registration_tokens : a matriz de tokens de IID para as instâncias de apps que você quer adicionar ou remover.

Resultados

Se for bem-sucedida, a chamada retornará o status HTTP 200. Resultados vazios indicam sucesso a assinatura do token. Para assinaturas com falha, o resultado contém uma destes códigos de erro:

NOT_FOUND: o token de registro foi excluído ou o app foi desinstalado.
INVALID_MCC — O token de registro fornecido não é válido para o ID do remetente.
INTERNAL — falha no servidor de back-end por motivos desconhecidos. Tente fazer a solicitação novamente.
TOO_MANY_TOPICS — número excessivo de tópicos por instância de aplicativo.
RESOURCE_EXHAUSTED: muitas solicitações de inscrição ou cancelamento de inscrição em um curto período. Tentar novamente com a espera exponencial.

Exemplo de solicitação `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..."],
}

Exemplo de resultado

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

Criar tokens de registro para tokens de APNs

Com o método batchImport do serviço de ID da instância, é possível importar em massa tokens de APNs do iOS existentes para o Firebase Cloud Messaging, mapeando-os com tokens de registro válidos. Chame o serviço de ID da instância em endpoint, fornecendo uma lista de tokens de APNs no corpo JSON:

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

O corpo da resposta contém uma matriz de tokens de registro de ID de instância prontos a ser usada para enviar mensagens do FCM ao token correspondente do dispositivo de APNs.

Parâmetros

Authorization: Bearer <access_token>: Defina esse parâmetro no cabeçalho. Adicione um token OAuth2 de curta duração como o valor do cabeçalho Authorization. Para mais informações sobre como conseguir esse token, consulte Fornecer credenciais manualmente.
access_token_auth: true: Defina esse parâmetro no cabeçalho.
application : ID do pacote do app.
sandbox : booleano para indicar ambiente de sandbox (TRUE) ou produção (FALSE)
apns_tokens : a matriz de tokens de APNs para as instâncias de apps que você quer adicionar ou remover. Máximo de 100 tokens por solicitação.

Resultados

Se for bem-sucedida, a chamada retornará o status HTTP 200 e um corpo de resultado JSON. Para cada token de APNs fornecido na solicitação, a lista de resultados incluirá:

O token de APNs.
Status. OK ou uma mensagem de erro descrevendo a falha.
Para resultados bem-sucedidos, o token de registro que o FCM mapeia para o token de APNs.

Exemplo de solicitação `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"
   ]
}

Exemplo de resultado

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

Respostas de erro

As chamadas para a API Instance ID Server retornam os seguintes códigos de erro HTTP:

HTTP status 400 (Bad request): os parâmetros de solicitação estão ausentes ou são inválidos. Verifique as mensagens de erro para ver informações detalhadas.
HTTP status 401 (Unauthorized): o cabeçalho de autorização é inválido.
HTTP status 403 (Forbidden): o cabeçalho de autorização não corresponde ao authorizedEntity.
HTTP status 404 (Not found) - Caminho HTTP ou token IID inválido não encontrado. Verifique as mensagens de erro para ver informações detalhadas.
HTTP status 503 (Service unavailable) - serviço indisponível. Tente de novo solicitação com espera exponencial.

Referência do servidor

Receber informações sobre instâncias de apps

Parâmetros

Resultados

Exemplo de solicitação GET

Exemplo de resultado

Criar mapas de relacionamento para instâncias de apps

Criar um mapeamento de relação para uma instância de app

Parâmetros

Resultados

Exemplo de solicitação POST

Exemplo de resultado

Gerenciar mapas de relacionamento para várias instâncias de app

Parâmetros

Resultados

Exemplo de solicitação POST

Exemplo de resultado

Criar tokens de registro para tokens de APNs

Parâmetros

Resultados

Exemplo de solicitação POST

Exemplo de resultado

Respostas de erro

Exemplo de solicitação `GET`

Exemplo de solicitação `POST`

Exemplo de solicitação `POST`

Exemplo de solicitação `POST`