Skip to main content

Integrations Q&A

What platforms does Shipbook support?​

Shipbook supports the following platforms:

  • iOS: Swift, Objective-C
  • Android: Kotlin, Java
  • React Native: JavaScript, TypeScript
  • Flutter: Dart

How long does integration take?​

The integration is quick and simple. It typically takes only 5 minutes to complete!

How do I integrate Shipbook into my iOS app?​

You can integrate Shipbook using CocoaPods, Carthage, or Swift Package Manager. Then, initialize the SDK in your AppDelegate:

ShipBook.start(appId:"YOUR_APP_ID", appKey:"YOUR_APP_KEY")

And then start logging:

Log.e("the log message") // Error log
Log.w("the log message") // Warning log
Log.i("the log message") // Info log
Log.d("the log message") // Debug log
Log.v("the log message") // Verbose log

For more details, see the iOS SDK Documentation.

How do I integrate Shipbook into my Android app?​

Shipbook is available on Maven Central. Add the following to your build.gradle file:

implementation 'io.shipbook:shipbooksdk:1.+'

The initialization is simple:

ShipBook.start(this, "YOUR_APP_ID", "YOUR_APP_KEY");

And then start logging:

Log.e("the log message"); // Error log
Log.w("the log message"); // Warning log
Log.i("the log message"); // Info log
Log.d("the log message"); // Debug log
Log.v("the log message"); // Verbose log

For more details, see the Android SDK Documentation.

How do I integrate Shipbook into my React Native app?​

Shipbook is available on npm. Install the package using npm or yarn: npm install --save react-native-shipbook-sdk

The initialization is simple:

import shipbook from '@shipbook/react-native';

shipBook.start("YOUR_APP_ID", "YOUR_APP_KEY");

And then start logging:

let log = shipbook.getLogger("MODULE_NAME");

log.e("the log message"); // Error log
log.w("the log message"); // Warning log
log.i("the log message"); // Info log
log.d("the log message"); // Debug log
log.v("the log message"); // Verbose log

For more details, see the React Native SDK Documentation.

How do I integrate Shipbook into my Flutter app?​

Shipbook is available on pub.dev. Add shipbook_flutter to your pubspec.yaml dependencies and run flutter pub get.

The initialization is simple:

Shipbook.start('YOUR_APP_ID', 'YOUR_APP_KEY');

To have a log on each class you need to create a logger:

final log = Shipbook.getLogger('MODULE_NAME');

The usage of the log:

log.e('the log message'); // Error log
log.w('the log message'); // Warning log
log.i('the log message'); // Info log
log.d('the log message'); // Debug log
log.v('the log message'); // Verbose log

For more details, see the Flutter SDK Documentation.

Does Shipbook support cross-platform frameworks?​

Yes, Shipbook has dedicated SDKs for React Native and Flutter, allowing you to log from both the native and JavaScript/Dart layers.

Can I integrate Shipbook with external tools?​

Yes, Shipbook integrates with:

  • Slack: Receive alerts directly in your Slack channels.
  • Jira: Link logs to issues.
  • Crashlytics: Link logs to crash reports.