SPARQUE API Wrapper

The SPARQUE API Wrapper significantly simplifies the integration process by abstracting away the intricate details of SPARQUE APIs. Rather than dealing with the complexities of modeling business logic and handling numerous API calls, users can now leverage a unified interface for seamless integration.

Traditionally, integrating SPARQUE has been a time-consuming task, particularly for new partners. The SPARQUE API Wrapper addresses this challenge by providing a standardized and simplified integration approach. This not only accelerates the onboarding process for new partners, but also reduces the overall time and effort required for integration.

• Single Search and Recommendations Endpoint

  One of the primary benefits of the SPARQUE API Wrapper is the provision of a unified solution. By offering a single search endpoint and a single recommendations endpoint, the Wrapper promotes consistency and clarity in API usage. This simplifies the interaction model for both clients and internal users.

• Accelerated Onboarding for Partners

  New partners can quickly integrate SPARQUE into their systems without having to learn the intricacies of API calls and business logic. The SPARQUE API Wrapper accelerates the onboarding process, allowing partners to start benefiting from SPARQUE's capabilities sooner.

• Reduced Development Effort

  With the SPARQUE API Wrapper, the development effort required for integration is significantly reduced. By abstracting away the technical complexities, developers can focus on implementing business logic instead of spending too much time on the integration process.

• Improved Maintenance and Upgrades

  As a centralized component, the SPARQUE API Wrapper facilitates easier maintenance and upgrades. Any changes to the SPARQUE APIs can be seamlessly accommodated within the SPARQUE API Wrapper, minimizing the impact on existing integrations and ensuring a smoother transition during updates.

  By adopting the SPARQUE API Wrapper, users can enjoy a more streamlined, efficient, and user-friendly experience when integrating SPARQUE functionality into their applications and systems.

• Standard configuration requirement

  The SPARQUE API Wrapper relies on a standard configuration to function optimally. This standardization ensures a seamless and straightforward integration process for most use cases. However, it is important to note that this standardized approach may pose challenges when attempting to implement highly customized activities that deviate significantly from the standard configuration.

• Challenges with custom activities

  For scenarios where custom activities are integral to the application or system, the SPARQUE API Wrapper may present challenges. The predefined structure of the SPARQUE API Wrapper might not accommodate highly specialized or unconventional use cases, making it less suitable for situations demanding a high degree of customization.

• Recommendation for custom development

  In cases where a significant number of developments outside the standard configuration are expected, it is advisable to connect directly to the SPARQUE Desk without using the SPARQUE API Wrapper. Direct integration provides more flexibility and control, allowing developers to tailor solutions to specific and unique requirements without constraints imposed by the SPARQUE API Wrapper's standardized approach.

Consider connecting directly to the SPARQUE Desk when:

• Customization is a critical requirement for your application.
• Your development involves activities that go beyond the scope of the standard configuration.
• Flexibility to adapt to evolving and highly specialized use cases is paramount.

In such scenarios, connecting directly to SPARQUE Desk ensures that your development team has the freedom to implement tailored solutions without limitations imposed by the SPARQUE API Wrapper's standardized structure.

While the SPARQUE API Wrapper excels in simplifying standard integration processes, users should evaluate their specific development needs and choose the most suitable approach based on the level of customization required for their applications.

Choose the appropriate environment for your development and production needs:

• ACCEPTANCE environment: uat.api.search.SPARQUE.ai

  Recommended for development, integration, and hosted test environments.

• PRODUCTION environment: api.search.SPARQUE.ai

  Used for client webshops in production environments.

Explore and test the SPARQUE API Wrapper using the Swagger playground. This sandbox environment is ideal for testing API functionality.

• Swagger UI Acceptance
• Swagger UI Production