Nected Docs
Try Nected For Free
  • 5 min QuickStart Guide
  • Getting Started
    • Introduction
    • Core Concepts
    • Use Cases
    • Tech Architecture
    • FAQs
  • INTEGRATIONS
    • Overview
    • Integrations Libraries
      • PostGres
      • MySQL
      • Oracle
      • MS SQL Server
      • Snowflake
      • MongoDB
      • RedShift
      • REST API
      • Google Sheets
      • Slack
    • Managing Integrations
  • DATASETS
    • Overview
    • Managing Dataset
  • Rules
    • Overview
    • Rule Types
      • SimpleRule
      • DecisionTable
      • Ruleset
      • Rule Chain
    • Rule Conditions
    • Rule Actions
    • Concepts
      • Rule Result
      • Test & Publish Rules
    • Add Input Attributes
      • JSON Input Attributes
      • List Input Attributes
  • Triggers
    • Trigger Rule via API
    • Trigger Rule via WebHook
    • Trigger Workflow via API
    • Trigger Workflow via WebHook
    • Scheduler
    • Rule Response Format
  • Workflow
    • Overview
    • Managing Workflow
    • Add Node
      • Action Nodes
        • Rule Node
        • Workflow Node
        • Custom Code Node
        • Database Node
        • REST API Node
      • Control Nodes
        • Loop Node
        • Delay Node
        • Response Node
        • Set Variables Node
        • Switch Block
    • Test & Publish Workflows
  • CODE AND DATABASE QUERIES
    • JavaScript Editor
    • Formula Editor
    • JSON Editor
    • List Editor
    • Excel-like Function
  • Embedded System
    • White-Labelling
    • Embeddable View
  • Self Hosting
    • Overview
    • Infrastructure Sizing
    • New Installation
      • Docker
      • Kubernetes
        • Set Up Kubernetes Cluster on AWS EKS
    • Additional Configuration
      • High Availability
      • Email Setup Guide
    • Upgrade Nected Version
  • Security
    • API Authentication
      • OAuth as part of Authentication under REST API
    • Role Based Access Control (RBAC)
    • SOC 2 Type 2, GDPR, ISO Compliance
  • Audit
    • Audit Trail
    • Approval Flow
    • Version Control & Rollback
    • Import/Export
  • Management API
    • Audit Log API
    • Global Variable API
  • References
    • Attribute Library
    • Global Variables
    • Pre-Configured Tokens
    • Pre-Configured Operators
    • NULL Value Handling/Behavior
    • Troubleshooting Errors
      • Multiple Tabs/Users Edits
      • Limits in Nected
    • Allowed Status Combinations
    • Environments
    • Usage Widget
    • Gen AI
  • ACCOUNT SETTINGS
    • Workspace Setting
      • Date Format and Timezone Settings
Powered by GitBook
On this page
  • Overview Flow of Embedded Users
  • Add Users To Enable Embeddable Flow
  • Generate Embeddable Signed URL for Users:
  • Embed Rule or Workflow listing UI inside your product via iframe
  • Error Handling and Response Codes
  • Best Practices and Recommendations
  • Support and Additional Resources
  1. Embedded System

Embeddable View

PreviousWhite-LabellingNextOverview

Last updated 5 months ago

Nected introduces a powerful framework for embedding users and providing pre-signed authentication. These features offer seamless integration and secure access control mechanisms, empowering organizations to embed Nected’s UI components and enable direct sign-ins with pre-signed URLs.

Overview Flow of Embedded Users

Below is the overview on how to generate pre-signed urls to embed rules and workflows within another product.

To integrate Embedded Users Flow with the Embedded View, here's how you can access and manage it for these users:

Add Users To Enable Embeddable Flow

  1. Navigate to Workspace Settings:

    • Go to the Workspace section in the Nected platform.

    • Click on the Embedded Users tab under the Workspace menu.

  2. Add Embedded Users:

    • Input the email address of the user in the "Add user by email" field.

    • Assign a role using the Select Role dropdown menu.

    • Click Add User to grant access.

Generate Embeddable Signed URL for Users:

For each user added, you can provide access to Embedded Views through the pre-signed authentication URL.

  1. Generate the Pre-signed Token using the provided API.

    Endpoint: (<https://api.nected.ai/dev/signed-token?email=>)<member-email>

    HTTP Method: GET

    Authentication Parameters

Parameter
Type
Required
Description

email

String

Yes

User's email address for token generation

nected-api-key

String

Yes

Organization's unique API authentication key

Example Authentication Request

curl --location '<https://api.nected.ai/dev/signed-token?email=%3CEMAIL_ID%3E>' \\
--header 'nected-api-key: {{NECTED_API_KEY}}'

2. Response Structure

When successfully executed, the API returns a comprehensive JSON response containing the pre-signed authentication token:

{
  "data": {
    "signedURL": "<https://app.nected.ai/signed-url/><<PreSigned-Token>>=?redirect="
  },
  "code": "success",
  "message": "success."
}
  1. Nected's pre-signed authentication supports targeted redirections, allowing administrators to guide users directly to specific platform sections:

Redirect Path
Destination Resource

/rules

Rule Management Interface

/workflow

Workflow Configuration Dashboard

Example Rule Url:


<https://app.nected.ai/signed-url/><PreSigned-Token>?redirect=/rules

Embed Rule or Workflow listing UI inside your product via iframe

Embed Workflow Example


<iframe
  src="<https://app.nected.ai/embed/><PreSigned-Token>?redirect=/workflow"
  width="100%"
  height="600"
  frameborder="0"
  allowfullscreen
></iframe>

Embedding via iframe is currently feasible for self-hosted deployments to avoid cross-domain issues. In Saas deployments, custom domains are not present thus preventing option to embedd UI due to cross-domain issue.

Error Handling and Response Codes

Comprehensive Error Classification

The pre-signed authentication API implements a robust error management strategy, providing clear, actionable feedback across various potential failure scenarios:

HTTP Status
Error Identifier
Description
Recommended Action

401

UNAUTHORIZED

Invalid or expired API credentials

Verify API key and regenerate if necessary

500

INTERNAL_SERVER_ERROR

Unexpected system malfunction

Contact Nected technical support

429

TOO_MANY_REQUESTS

Authentication request quota exceeded

Implement exponential backoff strategy

413

REQUEST_ENTITY_TOO_LARGE

Malformed authentication request

Validate request parameters and ensure payload size is within limits

400

BAD_REQUEST

Malformed authentication request

Validate request parameters

Best Practices and Recommendations

  1. Implement strict API key rotation policies

  2. Utilize HTTPS for all API interactions

  3. Generate pre-signed URLs dynamically and close to the point of use

  4. Establish clear access governance policies

  5. Regularly audit user access and permissions

Support and Additional Resources

Access the Postman workspace: . Locate the collection under "Embed Rules and Workflow White-labeling." Utilize provided APIs to fetch UI component configurations

For advanced implementation guidance, architectural consultations, or technical support, please get in touch with Nected's dedicated support team at

Nected Public Workspace
assist@nected.ai