Skip to main content

Getting Started

This guide provides a conceptual overview of how to get started with Entrupy. It outlines two primary paths:

  • SDK Integration: Developers integrate Entrupy SDKs into custom applications and use the API for backend operations.
  • Entrupy App: Business teams use the Entrupy App for capture; developers use the API to access and integrate the resulting data.

SDK Integration​

This path is for businesses that want to embed Entrupy's authentication and fingerprinting capabilities directly into their own applications (e.g., customer-facing marketplace apps, internal operational tools).

See the SDK-Based Workflows guide for more detailed walkthroughs, including common pre-listing workflows, post-sale workflows and high-volume seller async workflows.

Prerequisites​

  • You have an active Entrupy API key with SDK support.

Steps​

  1. Install and Configure the SDK

    • Integrate the appropriate Entrupy Mobile SDK (e.g., iOS, Android) into your application.
    • Follow the setup instructions for your chosen platform.

  2. Backend Token Generation

    • First, your client application needs to authorize with Entrupy. Your backend is responsible for securely authorizing your user and request credentials via Entrupy's API.
    • Your backend calls an authorization endpoint (POST /v2/integrations/authorize-user - refer to the API Reference for more details) to sign an authorization request from your mobile client.
    • The API returns a signed request that your backend then passes to your mobile application to use with the SDK.

  3. Launch and Complete Capture Flow

    • Your mobile application, using the SDK, launches the Entrupy Capture Flow.
    • It is advised to provide a unique customer_item_id for each item. This ID allows you to track the item and correlate it with Entrupy's results via API later.
      • If no ID is supplied, your application can also pass the generated Entrupy ID to your backend.
    • The user follows the on-screen instructions to photograph the item and submits all images to Entrupy's systems.

  4. Monitor Results

    • After data submission you can monitor the authentication status and access results using the SDK or API:
      • Via the SDK's Detail View, which automatically receives updated results.
      • Through webhooks configured to notify your backend of status changes.
      • By your backend polling the API using the customer_item_id or Entrupy ID (e.g., GET /v2/lookup/authentications/{your_customer_item_id} - check API Reference for available options).

Entrupy App​

This path is for businesses whose teams use the Entrupy App directly for authentication or fingerprinting operations and want to use the Entrupy API to access and manage the data generated by these activities.

See the Entrupy App Workflows guide for a more detailed walkthrough.

Prerequisites​

  • You are an existing Entrupy customer using the Entrupy app.
  • You have an active Entrupy API key.

Steps​

  1. Perform Authentication or Fingerprinting via Entrupy App

    • Use the Entrupy App and any required Entrupy hardware (e.g., microscopic lens for luxury items) to authenticate or fingerprint your items as per your normal operational workflow.
    • If you intend to lookup items via API with your own identifier, ensure your team consistently inputs a unique customer_item_id for each item during this process.
      • This input can be done manually or using a barcode or QR code.

  2. Monitor Results

    • Once an item has been processed through the Entrupy App, you can use the Entrupy API to retrieve its data using the submission's new Entrupy ID or the customer_item_id you assigned.
    • After data submission you can monitor the authentication status and access results using the app or API:
      • Via the app's result screen, which shows the latest results.
      • Via notifications in the mobile app's notification center.
      • Through webhooks configured to notify your backend of status changes.
      • By your backend polling the API using the customer_item_id or Entrupy ID (e.g., GET /v2/lookup/authentications/{your_customer_item_id} - check API Reference for available options).

Use Cases for the Entrupy API​

  • Automating data entry: Pull authentication results and certificate links directly into your internal inventory management systems, ERPs, or e-commerce platforms.
  • Custom reporting: Generate custom reports based on authentication data.
  • Data synchronization: Keep your internal systems updated with the latest authentication information for items processed via the Entrupy App.
  • Integrating with other business processes: Trigger downstream actions in other systems based on authentication outcomes.

For more detailed information on how businesses using the Entrupy App can integrate their data using the API, see the API Integration guide.