Home
Wiki
    logoPowered by Apidog

    Getting Started

    Shopranos Platform: Getting Started Guide

    Welcome to the Shopranos Platform! This guide provides an overview of key sections to help you get started with themes, connectivity, feeds, APIs, apps, automation, and proxies.

    1. Themes

    Layout

    Customize the layout of your eShop to fit your brand’s style and improve user experience. Themes in Shopranos offer flexibility in design, allowing you to create a visually appealing and functional online store.

    • Theme Selection: Choose from a range of pre-designed themes.
    • Layout Adjustments: Modify layout elements such as headers, footers, and content areas.
    • Preview Changes: See how your changes look before applying them live.

    Components

    Components are reusable elements that you can add to your theme. They include elements like banners, product grids, and navigation menus.

    • Component Library: Access a library of pre-built components.
    • Custom Components: Create custom components to meet specific needs.
    • Drag-and-Drop Editor: Use a user-friendly editor to place components in your layout.

    Reusables

    Reusables are predefined sections or blocks that can be used across multiple pages. They help maintain consistency and reduce development time.

    • Create Reusables: Define reusable blocks for elements like headers or promotional banners.
    • Manage Reusables: Edit and update reusable sections globally from one place.

    Assets

    Assets include images, videos, fonts, and other media used in your eShop. Manage these to ensure your store has the necessary visual and functional elements.

    • Upload Assets: Add images, videos, and other media to your asset library.
    • Organize Assets: Categorize and tag assets for easy retrieval.

    SDK

    The Software Development Kit (SDK) provides tools and documentation for extending Shopranos functionality.

    • Access SDK Documentation: Find guides and references for using the SDK.
    • Integrate Custom Features: Use the SDK to build and integrate custom features and functionalities.

    VS Code Plugin

    The VS Code plugin allows you to develop and customize your Shopranos themes directly within Visual Studio Code.

    • Install the Plugin: Download and install the Shopranos VS Code plugin.
    • Develop Locally: Use the plugin to code and test your theme changes locally before deploying.

    2. Connectivity

    Introduction

    Connectivity in Shopranos allows you to integrate with external systems and services, facilitating data exchange and functionality enhancement.

    Softone

    Softone integration provides seamless connectivity with your ERP system. Set up and configure connections to synchronize data between Shopranos and Softone.

    • Configure Integration: Follow the setup instructions to link Shopranos with your Softone ERP system.
    • Synchronize Data: Ensure data like orders, products, and customer information are up-to-date.

    Datapump

    Datapump facilitates direct communication between Shopranos and external ERP systems. It supports various functions such as order creation and price calculations.

    • Core Functions: Utilize functions like CreateOrder, CalculatePrices, and CalculateCatalogPrices.
    • Monitor Requests: Use the log stream to view and test API calls for debugging and validation.

    3. Feeds

    Feed Creation

    Create custom data feeds to export product and other data from Shopranos to external systems.

    • Define Feed Rules: Set rules for which data to include in the feed.
    • Customize Output: Use JavaScript to transform and format data.

    Feed Simulation

    Test your feed to ensure it outputs data as expected before deploying it.

    • Preview Feed: Use the simulation tool to see how the feed data will be structured.
    • Debug Issues: Adjust rules and transformations based on the simulation results.

    Feed Execution

    Execute feeds to export data based on your configuration.

    • Schedule Execution: Automate feed generation at specified intervals.
    • Monitor Status: Track the status and success of feed executions.

    4. APIs

    Overview

    Shopranos APIs enable programmatic access to your eShop's data and functionality. Use APIs to integrate with other systems or build custom applications.

    • API Documentation: Review the API documentation for available endpoints and usage.
    • Generate API Keys: Securely create and manage API keys for authentication.
    • Make API Calls: Use RESTful APIs to interact with orders, products, customers, and more.

    5. Apps

    Overview

    Apps extend the capabilities of your Shopranos eShop, adding new features and integrations.

    • Browse App Store: Discover and install apps from the Shopranos App Store.
    • Custom Apps: Develop and integrate your own apps to meet specific business requirements.
    • Manage Apps: Enable, configure, or remove apps through the management interface.

    6. Automation

    Power Automate

    Integrate Shopranos with Microsoft Power Automate to automate workflows and processes.

    • Create Flows: Set up triggers and actions to automate tasks such as sending notifications or updating records.
    • Connect to Shopranos: Use your Shopranos API key to establish a connection with Power Automate.

    Web Hooks

    Web hooks enable real-time data synchronization and event-driven automation.

    • Create Web Hooks: Define web hooks to respond to events such as order creation or updates.
    • Configure Web Hooks: Set the title, URL, status, entity, and event type for each web hook.

    7. Proxies

    Using Proxies

    Proxies in Shopranos allow you to securely make external API calls from your eShop frontend.

    • Create a Proxy: Define the external URL, headers, and authentication settings.
    • Generate Proxy URL: Use the Shopranos-generated URL to make secure API calls from your frontend.

    Transformations

    Customize how data is handled by using JavaScript to transform request and response data.

    • Request Transformation: Modify outgoing requests before they are sent to the external API.
    • Response Transformation: Process and format the response data before it is returned to the frontend.

    This Getting Started guide provides a comprehensive overview of the key sections in Shopranos. Explore each section to fully leverage the platform's capabilities and tailor it to your business needs. Happy building!

    Last modified: 3 months ago