Back to Plans

Streamlined Fabric Onboarding Plan for Startups

A focused SaaS onboarding plan for startups and small teams integrating with Fabric, covering essential setup, core API integration, and basic security.

https://developer.fabric.inc/home

Version: 1.0
3 Departments
8 Tasks
13 Subtasks

Initial Setup & Authentication

Quickly get account access and learn to authenticate API requests.

Competencies

Basic API Concepts
Secure Credential Handling

Tasks

Quick Account & API Credential Setup

Obtain Fabric account access and the necessary API credentials for your System App.

Goals

  • Gain access to Fabric Copilot.
  • Securely obtain Client ID, Client Secret, and Authorization URL.

Deliverables

  • Active Fabric Copilot login.
  • System App API credentials stored securely.

Subtasks

Request and Access Trial Account
Contact Fabric for a trial account to access the platform. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)

Goals

  • Activate Fabric environment.

Deliverables

  • Login credentials for Fabric Copilot.

Steps

  • Reach out to Fabric sales/support. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication)
  • Log in to Copilot once credentials are received. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
Get System App Credentials
Create or identify a System App in Copilot to get API keys. (https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication, https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)

Goals

  • Obtain Client ID, Client Secret, and Auth URL.

Deliverables

  • List of API credentials.

Steps

  • In Copilot, go to Settings > Developer Tools > API Apps. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
  • Use an existing System App or create a new one (admin rights needed). (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/platform/settings/api-apps/creating-system-app)
  • Securely record the Client ID, Client Secret, and Authorization URL. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)

Understand and Perform API Authentication

Learn the basics of Fabric's API authentication and generate an access token.

Goals

  • Successfully authenticate and receive an API access token. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)

Deliverables

  • Valid Bearer token for API calls.

Subtasks

Review System App Authentication Flow
Understand the OpenID Connect Client Credential Flow used by Fabric. (https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication, https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)

Goals

  • Know how to request a token.

Deliverables

  • Basic understanding of the authentication process.

Steps

  • Read the API Authentication section in the developer portal. (https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication)
Generate Access Token
Use your System App credentials to make a /token request. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)

Goals

  • Obtain an active access token.

Deliverables

  • `access_token` received from Fabric.

Steps

  • Use Postman/cURL to POST to {{authURL}}/v1/token with client_id, client_secret, grant_type='client_credentials', scope='s2s'. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/getting-started/authentication-v3/authentication-endpoints/fetch-access-token, https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)
  • Note the `access_token` and `expires_in` from the response. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)

Core API Integration & Basic Implementation

Focus on integrating with one or two key Fabric APIs essential for your MVP (e.g., Product Catalog, Orders).

Competencies

REST API Interaction
Basic Data Handling (JSON)

Tasks

Identify and Plan Core API Usage

Select the most critical Fabric APIs for your initial integration and plan their use.

Goals

  • Define the scope of the initial API integration.

Deliverables

  • List of 1-2 core Fabric APIs to integrate (e.g., Product Catalog API, Orders API).
  • Basic data flow diagram for these APIs.

Subtasks

Review Key Module APIs
Briefly review APIs for Product Catalog, Orders, and Inventory to choose the initial focus. (https://developer.fabric.inc/v3/getting-started/api-guides/api-references)

Goals

  • Select APIs critical for MVP launch.

Deliverables

  • Decision on primary APIs for integration.

Steps

  • Consult Fabric API references. (https://developer.fabric.inc/v3/getting-started/api-guides/api-references)
  • Prioritize based on core business needs (e.g., display products, accept orders).
Understand Basic Identifiers (SKU)
Learn how SKUs are used in Fabric, especially within Product Catalog and Orders. (https://developer.fabric.inc/v3/getting-started/api-guides/identifiers, https://developer.fabric.inc/v3/getting-started/api-guides/identifiers)

Goals

  • Use SKUs correctly in API calls.

Deliverables

  • Understanding of SKU as a primary product identifier.

Steps

  • Refer to Fabric's guide on identifiers. (https://developer.fabric.inc/v3/getting-started/api-guides/identifiers)

Implement Basic API Interactions

Develop code to perform essential operations with the chosen Fabric APIs.

Goals

  • Successfully send requests and receive responses from core Fabric APIs.

Deliverables

  • Working code snippets for key API calls (e.g., fetch product, create order).

Subtasks

Make Your First API Request (e.g., Get Product)
Follow the 'Making your first API request' guide, adapting it for a chosen endpoint like retrieving a product by SKU. (https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request, https://developer.fabric.inc/v3/getting-started/api-guides/example)

Goals

  • Successfully retrieve data from Fabric.

Deliverables

  • Successful API response for a GET request.

Steps

  • Use your access token in the Authorization header. (https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request)
  • Include `x-fabric-tenant-id`. (https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request)
  • Call a GET endpoint (e.g., `/products/sku/{sku}` from Product Catalog API). (https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/delete-product-by-sku)
Implement Basic Error Handling
Add simple error checking for API responses (e.g., check for HTTP 2xx status codes).

Goals

  • Ensure your integration can identify basic success/failure of API calls.

Deliverables

  • Code that logs API errors.

Steps

  • Check HTTP status codes.
  • Log error messages from API responses.

Initial Data Setup (Manual or Simple Import)

Populate Fabric with essential data for testing (e.g., a few products, a test category).

Goals

  • Have minimal viable data in Fabric to test integrations.

Deliverables

  • A small set of test data (e.g., 1-5 products) in Fabric.

Subtasks

Manually Add Test Product(s) via Copilot or API
Create a few sample products using the Product Catalog features in Copilot or via API for simplicity. (https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/adding-an-item, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/get-files-available-for-a-merchant)

Goals

  • Populate with enough data for basic testing.

Deliverables

  • Test products visible in Fabric.

Steps

  • If using API: Define basic attributes, then use the 'Add Product' endpoint. (https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/developer-guide/configuring-product-catalog, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/get-files-available-for-a-merchant)
  • If using Copilot: Navigate to Product Catalog > List > Items and add items. (https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/adding-an-item)

Basic Testing & Go-Live Preparation

Conduct essential testing of the core integration and prepare for a simple go-live.

Competencies

Basic Software Testing
Deployment Fundamentals

Tasks

Test Core Integration Functionality

Verify that the primary integration points are working as expected.

Goals

  • Confirm data flows correctly for essential operations.

Deliverables

  • Successful test results for core scenarios.

Subtasks

Perform End-to-End Test for Primary Workflow
Test a complete user journey involving the integrated Fabric APIs (e.g., view product on storefront, place test order, see order in Fabric).

Goals

  • Validate the main integration path.

Deliverables

  • Confirmation of successful end-to-end flow.

Steps

  • Simulate a customer action.
  • Verify data consistency across systems.

Basic Security Checks

Ensure API credentials are handled securely.

Goals

  • Verify no exposure of sensitive API keys.

Deliverables

  • Confirmation of secure credential storage.

Subtasks

Verify Secure API Key Storage
Ensure Client ID and Secret are not hardcoded or exposed in client-side code. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)

Goals

  • Protect API credentials.

Deliverables

  • Secure handling of API keys confirmed.

Steps

  • Store credentials as environment variables or in a secure backend configuration.

Prepare for Simple Go-Live

Outline steps for deploying the integration to a live environment.

Goals

  • Achieve a smooth deployment.

Deliverables

  • Simple deployment plan.

Subtasks

Configure Production Environment Variables
Set up production API keys and endpoint URLs.

Goals

  • Ensure correct configuration for live system.

Deliverables

  • Production environment configured.

Steps

  • Update application settings with production Fabric credentials and tenant ID.
Deploy and Monitor
Deploy the integration and perform initial monitoring.

Goals

  • Launch the integration successfully.

Deliverables

  • Integration live in production.

Steps

  • Deploy code to production server.
  • Perform smoke tests on live environment.
  • Monitor logs for any immediate errors.
© 2024 underrun.io All rights reserved

Navigation

Legal & Contact

All trademarks, service marks, trade names, product names, and logos appearing on this site are the property of their respective owners. This website's use of these marks is solely for the purpose of identifying and referencing the respective companies and their products. We disclaim any affiliation, endorsement, or sponsorship by or with these trademark owners. The trademark of underrun is owned by underrun.io