SDK

Introduction

Integrate the SDK into your iOS and Android apps to start tracking users and generating events. The SDK abstracts away cross-platform differences between location services on iOS and Android, allowing you to add location context and tracking to your apps with just a few lines of code.

NearX defaults to a balance of accuracy, reliability, responsiveness, and battery efficiency suitable for most use cases.

Accuracy and reliability

Smartphone location services are not perfect. On iOS and Android, location services use a combination of GPS, wi-fi scanning, and cell tower scanning to determine the user's location. Accuracy and reliability may be reduced if wi-fi is turned off, especially indoors, or if wi-fi is unavailable, such as in sparse suburban or rural areas.

In addition, accuracy and reliability may be reduced by battery-saving features like iOS Low Power Mode, which restricts background app refresh, Android Doze Mode and App Standby, which restrict wi-fi scanning and network access, and Android O Background Location Limits, which restricts background location updates.

Note: In general, these restrictions apply to all apps and SDKs using location services on iOS and Android, not just NearX. NearX achieves a balance of accuracy, reliability, responsiveness, and battery efficiency suitable for most use cases.

Authentication

Authenticate using your publishable API keys, found on the Settings page. Use your Test Publishable key for testing and non-production environments. Use your Live Publishable key for production environments.

Note: You should always use your publishable API keys, which are restricted in scope, in the SDK. Do not use your secret API keys, which are unrestricted in scope, in any client-side code.

Integrations

Learn more about SDK integrations here

Support

Have questions after reading the documentation? Contact us here