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​

The Entrupy SDK requires access to the device's camera to capture images for the authentication process.

To request camera access from the user, you must add the NSCameraUsageDescription key to your app's Info.plist file.

  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 the "+" button to add a new key.

  5. From the dropdown list, select Privacy - Camera Usage Description (or type NSCameraUsageDescription directly as the key).

  6. In the Value column next to the key, provide a clear and concise message to the user explaining why your app needs camera access. 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 attempts to access the camera for the first time, iOS will present this description to the user in a permission dialog. A clear explanation helps build user trust and increases the likelihood of them granting permission.

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