TypeScript typings for Google Play Integrity API v1

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification. For detailed description please check documentation.

Installing

Install typings for Google Play Integrity API:

npm install @types/gapi.client.playintegrity-v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://playintegrity.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.playintegrity
  }
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('playintegrity', 'v1', () => {
  // now we can use:
  // gapi.client.playintegrity
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // Private Service: https://www.googleapis.com/auth/playintegrity
    'https://www.googleapis.com/auth/playintegrity',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  }
);

After that you can use Google Play Integrity API resources:

/*
Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).
*/
await gapi.client.playintegrity.deviceRecall.write({
  packageName: 'packageName',
});

/*
Decodes the integrity token and returns the token payload.
*/
await gapi.client.playintegrity.decodeIntegrityToken({
  packageName: 'packageName',
});