Concepts

Environments #

There are currently two distinct environments used within the One2Five universe to accommodate different stages of development.
Each environment is deployed within their own independent infrastructure.

NOTE:

Login credentials may vary for different environments. For example, your production API-key will not grant access to the API on the staging environment.
  1. Staging (https://test.one2five.digital)
    The staging environment is exclusively dedicated to testing purposes. Changes made in this environment do not impact live data or content. It serves as a testing ground for developers to validate their implementations against the platform’s interfaces and test out concepts. New features might at times be made available on staging to allow testing before the time of actual release to production. No human moderation will be conducted on the staging environment.
  2. Production (https://app.one2five.digital)
    The production environment is the live platform where all live data accumulates. We strongly recommend, connecting this environment only after successful testing and verification on the staging environment, as mistakes on the production environment can lead to irreversible loss of data. Content submitted to the production environment, once verified, will be eligable to moderation.

Locales & Display-Codes #

Locale

  • Definition: A locale refers to a specific regional or linguistic configuration used to customize content and user experiences based on geographical or language preferences.
  • Components:
    • Language Code: A two-letter code representing the language (e.g., “en” for English, “fr” for French).
    • Country Code: A two-letter code representing the country or region (e.g., “US” for the United States, “FR” for France).
  • Format: Locales are expressed as languageCode_countryCode (e.g., en_US for English in the United States, fr_FR for French in France).
  • Usage in O2F: Locales define the language and regional settings for presenting content, including text, dates, currency, and other region-specific details.

Display Code

  • Definition: A display code is an identifier used in O2F to specify how content is presented within a specific locale.
  • Purpose:
    • Differentiates content presentation for various brands or sub-brands within the same locale.
    • Ensures that users receive content tailored to the specific brand or sub-brand.
  • Example: Display codes like brandA-en_US and brandB-en_US might both target English-speaking users in the United States but show different content tailored for Brand A and Brand B, respectively.

Locale vs. Display Code

  • Locale:
    • Broadly defines the general language and regional settings.
    • Dictates localization, including formatting of text, dates, and currency.
  • Display Code:
    • Represents specific variations within a locale, such as different versions of content for the same language and region but tailored to different brands or sub-brands.
    • Ensures content is displayed correctly for the intended audience within a locale.

SFTP Integration #

Context of SFTP Usage in O2F

  • Secure File Transfers: SFTP (Secure File Transfer Protocol) is used in O2F to securely transfer data files between clients and the platform.
  • Common Use Cases:
    1. Product Catalog Feeds: Clients upload product catalogs via SFTP, which include information like descriptions, prices, and images. This data is utilized by O2F to ensure accurate and up-to-date product information across various platforms.
    2. Content Moderation: SFTP is employed to send user-generated content, such as product reviews or ratings, to O2F for moderation and processing.
    3. Data Exports: Clients download reports or data exports from O2F via SFTP. These exports may include metrics, analytics, and summaries of user-generated content.
  • Security: The use of SFTP ensures that data transfers are secure, encrypted, and reliable, thereby protecting sensitive information during transit.

Folder Structure and Meanings

Upload Folders:
  • PIE-Feeds:
    • Path: /ppe-inbox/
    • Purpose: Designated folder for uploading PIE-Feeds.
  • Product-Feed:
    • Path: /import-inbox/
    • Purpose: Designated folder for uploading Product-Feeds.
  • Badge-Feed:
    • Path: /badge-import/
    • Purpose: Designated folder for uploading Badge-Feeds.
Download Folders:
  • Review-Feed (Only Approved Reviews):
    • Path: /feeds/
    • Purpose: Folder for downloading the daily generated Review-Feed.
  • Review-Feed (Pending for Moderation, Approved, Rejected Reviews):
    • Path: /datalake_feeds/
    • Purpose: Folder for downloading the daily generated Review-Feed.

Automated Processes Linked to SFTP

  • Product Catalog Feeds: Automated processes may pick up product catalogs from the /import-inbox/ folder and process them to update product information on the platform.
  • Content Moderation: Files uploaded to the designated SFTP folders are automatically processed for moderation and further actions within the O2F platform.
  • Data Exports: Data is automatically compiled and placed in the /feeds/ folder for clients to download at their convenience.

SFTP Capability Overview

  • Introduction: This section introduces the SFTP capability of the O2F Review Platform, enabling seamless data exchange to and from the platform through any compatible FTP application.

API Access #

Concept Behind the O2F API

  • Definition: The O2F API provides programmatic interfaces for interacting with the O2F platform, allowing businesses to manage and integrate user-generated content (UGC) into their digital platforms.
  • Key Concepts:
    1. Content Management:
      • Submit, retrieve, and manage UGC such as reviews, ratings, questions, and answers.
      • Includes posting new reviews, retrieving existing reviews, and moderating content.
    2. Integration:
      • Seamlessly integrate O2F features into client websites or apps.
      • Display reviews, ratings, and other content directly on client platforms to enhance user experience.
    3. Data Access:
      • Access detailed data and analytics related to customer feedback.
      • Includes sentiment analysis, ratings distribution, and review volume for data-driven decision-making.
    4. Customization and Flexibility:
      • Customize how UGC is collected, displayed, and used.
      • Allows for personalized experiences that align with brand guidelines.
    5. Real-time Interactions:
      • Supports real-time interactions to ensure content is up-to-date with the latest user feedback and engagement.
  • Purpose: The O2F API helps businesses harness UGC to build trust, increase engagement, and drive conversions by integrating authentic customer voices into their digital experiences.

API Keys

  • Definition: API keys are security mechanisms used to control access to the API.
  • Uses:
    1. Authentication:
      • Authenticate requests to ensure only authorized users or systems can access the API.
      • Each API key is unique to a specific account or application.
    2. Authorization:
      • Determine the level of access granted.
      • Permissions associated with an API key may allow different operations like reading, writing, or modifying data.
    3. Rate Limiting:
      • Track usage and enforce rate limits to prevent abuse.
      • Limits the number of API requests that can be made within a certain timeframe.
    4. Tracking and Monitoring:
      • Monitor usage patterns and track API activity.
      • Helps in identifying issues, optimizing performance, and providing support.
    5. Security:
      • Ensure requests are from authorized sources.
      • Protect against unauthorized access and potential misuse.
  • Summary: API keys are crucial for secure, controlled, and efficient access to O2F API services.

API Key Management

  • Important Note:
    • Distinct API Keys are required for different environments.
    • An API Key for the staging environment cannot be used in the production environment, and vice versa.
    • Refer to the “Environments” section for comprehensive details on the various environments.
  • Support: Feel free to get in touch if you have any questions – we are happy to support.

Link to API Reference

For detailed API documentation and usage instructions, please refer to the API Reference.