Skip to main content

B. App Registration & Permissions

Before you can fully use the Entrupy iOS SDK, your application needs to be registered with Entrupy, and you must configure necessary app permissions.

1. Registering Your Application​

To integrate the Entrupy SDK, your application's bundle ID must be registered with Entrupy.

  • Contact Entrupy: Reach out to Entrupy support or your designated Entrupy contact (e.g., developer@entrupy.com or your account manager) to initiate the app registration process.
  • Provide Bundle ID: You will need to provide your app's unique bundle identifier (e.g., com.yourapp.bundleid).
  • Intended Use: Briefly describe how you plan to use the Entrupy SDK within your application.

Upon approval, Entrupy will provide you with an API Key. This key is essential for initializing and using the SDK.

important

Keep your API Key confidential and secure. It authorizes your app to interact with Entrupy services.

2. Requesting App Permissions​

2.1 Camera Access​

The Entrupy SDK requires access to the device's camera to capture images for the authentication process. Add NSCameraUsageDescription to your app's Info.plist.

Steps:

  1. Open your project in Xcode.
  2. Select your project in the Project Navigator.
  3. Go to your app target's Info tab.
  4. Under "Custom iOS Target Properties," click "+" to add a new key.
  5. Select Privacy - Camera Usage Description (or type NSCameraUsageDescription).
  6. Provide a clear message to the user, for example:
    • "This app needs access to your camera to take photos of items for authentication by Entrupy."
    • "Camera access is required to capture images for item verification."

Example Info.plist entry (raw XML view):

<key>NSCameraUsageDescription</key>
<string>Your reason for needing camera access to authenticate items.</string>

When the SDK first accesses the camera, iOS presents this message in a permission dialog.

2.2 Photos Library Additions (Optional)​

If your app implements the SDK Detail View, add NSPhotoLibraryAddUsageDescription to your app's Info.plist to enable saving Entrupy Certificates to the Photos library.

Steps:

  1. Open your project in Xcode.
  2. Select your project in the Project Navigator.
  3. Go to your app target's Info tab.
  4. Under "Custom iOS Target Properties," click "+" and add Privacy - Photo Library Additions Usage Description (or NSPhotoLibraryAddUsageDescription).
  5. Provide a clear message, for example:
    • "This app needs permission to save Entrupy Certificates of Authenticity to your Photos library."

Example Info.plist entry (raw XML view):

<key>NSPhotoLibraryAddUsageDescription</key>
<string>This app needs permission to save Entrupy Certificates of Authenticity to your Photos library.</string>

After completing these steps, proceed to learn about SDK User Authorization.