Skip to main content

API Integration Workflows

The Entrupy API is the comprehensive backbone for partner data management, configuration, and programmatic control over processes that complement both SDK-driven and Entrupy App-driven functionalities. It allows your backend systems to interact with data on the Entrupy platform, regardless of how that data was initially captured.

View API documentation here. and the OpenAPI reference here.

Core API Capabilities​

The Entrupy API serves as the central interface for all backend data access and process management, regardless of whether data originates from SDK-driven or Entrupy App-driven workflows. It enables your systems to:

  • Comprehensive Data Access & Retrieval:
    • Access authentication results (e.g., "Authentic," "Unidentified"), status updates, Entrupy Certificate information (including links), fingerprint registration and verification details, and listing images (thumbnails, high-resolution) captured by Entrupy.
    • Retrieve detailed Catalog Data, including product attributes, condition assessment (if available), and marketplace listings (if available).
  • Data Correlation: Utilize the unique customer_item_id (which your system provides during SDK or app operations) to track items and correlate them with Entrupy's results and identifiers across all workflows.
  • Process & Workflow Management:
    • Programmatically manage SDK sessions.
    • Configure and manage webhooks for real-time event notifications (e.g., authentication completion, status changes), enabling more reactive and efficient integrations than polling.
    • Initiate and manage B2B and B2C non-verified Certificate Transfers. (Verified transfers are a mid-term roadmap item).
    • Raise and manage flags on items via the API to escalate for review by Entrupy.
    • Manage fingerprint records (this goes beyond just retrieving verification details and includes managing the records themselves).
    • Programmatically mark items as abandoned (e.g., if a user cancels a listing or a requested retake times out).
  • Support Interactions: Access conversation history, event timelines, and available structured message choices for per-item support interactions. This can complement the SDK's support UI or enable the development of custom support dashboards.
  • Wide Integration: Incorporate Entrupy data into your ERP, inventory systems, e-commerce platforms, or custom reporting and analytics dashboards.
  • Read/Write Permissions: The API is generally read-only for core authentication data (the results of Entrupy's assessment) but allows read-write access for auxiliary data, such as integrator-managed metadata or configurations related to your items or account.

API with SDK-Based Workflows​

When your users interact with Entrupy features via an SDK embedded in your application:

  • Session Authorization: Your backend uses the API to authorize SDK sessions and tie them to a particular user.
  • Result Retrieval & Management: While the SDK can display results, your backend will typically use the API to fetch definitive authentication/fingerprinting results, certificate details, and catalog data for storage and further processing.
  • Complementary Actions: Use the API for actions not directly handled by the SDK user interface, such as managing flags or initiating certificate transfers for items authenticated via the SDK.

API with Entrupy App Workflows​

When your internal teams use the Entrupy app for authentication or fingerprinting:

  • Data Synchronization: Your backend can pull records directly by their Entrupy ID or by your custom customer_item_id entered during the Entrupy app process.
  • Automated Updates: Automatically update inventory systems with authenticity status, populate e-commerce listings with certificate links, or feed data into internal dashboards based on app activity.

Technical Implementation Notes for API Integration​

  • API Authentication: Securely manage and use your API credentials for all backend communication with api.entrupy.com.
  • customer_item_id Management: This identifier is important. Ensure its uniqueness and accurate association with your items across all workflows (SDK and app) for reliable API lookups.
  • Error Handling & Retries: Implement robust error handling for API calls (network issues, rate limits, invalid requests) and include retry mechanisms where appropriate.
  • Data Mapping: Carefully map data fields from Entrupy API responses to your internal system's data structures.
  • API Versioning: Be aware of API versioning (e.g., v1.x vs. the upcoming v2.0) and consult the relevant API Reference and Changelog for the most current endpoint details and data schemas.

By using the Entrupy API, you can deeply integrate Entrupy's capabilities into your backend systems. This creates powerful, automated, and data-rich workflows that enhance your platform's value and operational efficiency, whether you use the SDK, the Entrupy app, or a combination of both for item processing.

Next Steps​