Skip to main content

How to use Authentication keys • App API key • REST API key • Authentication keys examples

Learn how to use App API keys to initialize the Shake SDK and REST API keys to access your Shake data programmatically.

Written by Shake Typing

How to use Authentication keys

You can find your Authentication keys in the Shake dashboard under Workspace administration > App > Authentication keys. To create a new key, click "Create key" and choose the type you need.

App API key

Use the App API key to initialize the Shake SDK in your app. It goes directly into your source code.

iOS (Swift):

swift

import Shake  Shake.start(apiKey: "app-api-key")

Android (Kotlin):

kotlin

import com.shakebugs.shake.Shake  Shake.start(this, "app-api-key")

React Native (in your Shake dashboard, create two separate apps, one for iOS and one for Android. Each app has its own App API key, which you then use for the corresponding platform):

javascript

import { Platform } from 'react-native'; import Shake from '@shakebugs/react-native-shake';  const apiKey = Platform.OS === 'ios' ? 'ios-app-api-key' : 'android-app-api-key'; Shake.start(apiKey);

Flutter (in your Shake dashboard, create two separate apps, one for iOS and one for Android. Each app has its own App API key, which you then use for the corresponding platform):

dart

import 'dart:io'; import 'package:shake_flutter/shake_flutter.dart';  String apiKey = Platform.isIOS ? 'ios-app-api-key' : 'android-app-api-key'; Shake.start(apiKey);

Web:

javascript

import Shake from '@shakebugs/browser';  Shake.start('app-api-key');

REST API key

Use the REST API key to access your Shake data programmatically. Include it as a request header:

X-API-KEY: your_rest_api_key_here

Here's what you can do with it:

  • Fetch bug reports and push them into your own issue tracker

  • Pull crash groups and check how many events each one has

  • Update the status, priority, or assignee of a report without opening the dashboard

  • Reply to a user or add an internal note from your own system

  • Retrieve your full list of team members and their roles

Example: fetching all user feedback:

bash

curl -H "X-API-KEY: your_rest_api_key_here" \   "https://dashboard-api.shakebugs.com/api/rest/issue_tracking/issues?limit=20&offset=0"

For all available endpoints, check out the REST API docs. Rate limit is 200 requests per hour.

Did this answer your question?