HomeDocumentationAPI Reference
Getting StartedAPI ReferenceBug ReportingCrash ReportingAPMHelp Center

Store Integration

To integrate your App Store or Play Store account, you'll need to navigate to the settings page in the side navigation bar.

Depending on the OS of the current application, you'll find the relevant store integration.

iOS - App Store

Create Integration

  1. To integrate with the App Store, first generate an API Key with “App Manager“ access.
    After generating the key, enter your Key ID and Issuer ID, then upload your .p8 file.

  1. Choose Bundle ID: We'll fetch all bundle IDs associated with the created Key ID.

  1. You now have a successful connection.

How to generate an API Key for App Store Connect

  1. Log in to App Store Connect.
  2. Select Users and Access, and then select the API Keys tab.
  3. Click Generate API Key or the Add (+) button.
  4. Enter a name for the key. The name is for your reference only and is not part of the key itself.
  5. Under Access, select the App Manager or Admin role for the key
  6. Click Generate.

The new key's name, key ID, download link, and other information will appear on the page. The private key is available for download a single time. You can check Apple's documentation for it here.

App Store Connect Dashboard

App Store Connect Dashboard

📘

How we prioritize the security of your integration

  • API Key Management: We follow best practices for safeguarding API keys, including secure storage by encrypting your key and only decrypting it at runtime.
  • Data Encryption: We use industry-standard encryption for data transmitted between Instabug and App Store Connect to keep your information secure during transit.

Edit Integration

  1. After creating the integration successfully, you can edit the integration by choosing another bundle ID associated with the Key ID by clicking on the pencil icon.

  1. Choose the new Bundle ID.

🚧

You will not be able to edit the key details.

Delete Integration

You can delete the Bundle ID associated with our dashboard and we won’t be able to fetch any details from the store for this Bundle ID.

🚧

Deleting this integration will not delete the key from the dashboard. The key will be permanently deleted once all integrations using this key are deleted.

Android - Google Play

Create Integration

  1. Log in to the Google Play Console and sign in to your account as the owner of the developer account.
  2. Navigate to API access: In the left-hand menu, select "Settings" and then "Developer account". Under "Developer account", select "API access".
  3. Create a new service account: Scroll down to the "Service Accounts" section and click the "Create service account" button. Follow the prompts to create a new service account.
Create new service account

Create new service account

  1. Fill out Account name: Add a name for the account created for Instabug.
Account Name

Account Name

  1. Generate a key: After you've granted permissions, click on the service account name and then select the "Keys" tab. Click the "Create new key" button and select "JSON" as the key type.
Generate Key

Generate Key

Pick JSON

Pick JSON

  1. Download Service account key file: Your service account key file should start downloading, you’ll need to upload that key on our dashboard.
  2. Grant access to the relevant app: Ensure that the service account has access to the app you're setting up in the Instabug dashboard. Add the necessary permissions by clicking the "Edit" button next to the app or account, selecting the appropriate permissions, and clicking "Add". Once you've added the necessary permissions, click "Save Changes" to apply the changes.
  3. Grant Permission: You'll need to allow the Release to production, exclude devices, and use Play App Signing permission to be able to use rollout management .
  4. After creating the service account, you’ll need to upload the Package name and Key in the Instabug dashboard.

  1. You now have a successful connection.

📘

How we prioritize the security of your integration

  • API Key Management: We follow best practices for safeguarding API keys, including secure storage by encrypting your key and only decrypting it at runtime
  • Data Encryption: We use industry-standard encryption for data transmitted between Instabug and the Play Store Console to keep your information secure during transit.

Edit Integration

  1. After creating the integration successfully, you can edit the integration by entering another package name associated with the Key ID by clicking on the pencil icon.

  1. Enter the other package name.

🚧

You will not be able to edit the key details.

Delete Integration

You can also delete the package name associated with the Instabug dashboard, and we won’t be able to fetch any details from the store for this package name.

🚧

Deleting this integration will not delete the key from the dashboard. The key will be permanently deleted once all integrations using this key are deleted.