Essential Fabric Onboarding Plan
A comprehensive plan for onboarding onto the Fabric Composable Commerce Platform, covering key tasks from initial setup and authentication to API integration and go-live.
https://developer.fabric.inc/home
Version: 1.0
5 Departments
18 Tasks
47 Subtasks
Initial Setup & Platform Familiarization
Covers initial account setup, understanding Fabric's architecture, API authentication, and available resources.
Competencies
Understanding Headless Commerce Concepts
API Fundamentals (REST, OpenAPI)
Authentication Protocols (OpenID Connect)
Navigating Developer Portal & Documentation
Account Setup and Credential Acquisition
Setting up your Fabric trial account and obtaining necessary API credentials.
Goals
- Gain access to the Fabric platform and secure API keys.
Deliverables
- Active Fabric Copilot account
- System App Client ID and Client Secret
- Authorization URL
Request Trial Account
Reach out to Fabric to get a trial account and environment setup. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
Goals
- Obtain a working Fabric environment for development and testing.
Deliverables
- Confirmation of trial account activation.
Steps
- Contact Fabric sales or support for a trial account. (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)
Access Copilot Account
Ensure you have credentials to access your Copilot account. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
Goals
- Successfully log in to the Fabric Copilot interface.
Deliverables
- Ability to navigate the Copilot dashboard.
Steps
- Log in to your Copilot account using the provided credentials. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
Create/Identify System App for API Access
A System App is required for API authentication using OpenID Connect's Client Credential Flow. (https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication)
Goals
- Obtain Client ID, Client Secret, and Authorization URL for API calls.
Deliverables
- System App Client ID noted
- System App Client Secret securely stored
- Authorization URL noted
Steps
- Navigate to Settings > Developer Tools > API Apps in Copilot. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
- Identify an existing System App or create a new one (requires admin rights). (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
- Note the Authorization URL, Client ID, and Client Secret for the System App. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
Understand Fabric API Authentication
Learn how Fabric APIs handle authentication for System Apps.
Goals
- Understand the Client Credential Flow used by Fabric System Apps. (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)
Deliverables
- Understanding of the token generation process.
Review API Authentication Documentation
Study the API Authentication guide on the Fabric Developer Portal. (https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication)
Goals
- Grasp the concepts of System App authentication and token-based access. (https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication, https://developer.fabric.inc/v3/getting-started/authentication-v3/concepts)
Deliverables
- Summary of authentication flow.
Steps
- Read about System App Authentication and OpenID Connect Client Credential Flow. (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)
Generate Your First Access Token (System Token)
Use your System App credentials (Client ID, Client Secret, Authorization URL) to request an 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)
Goals
- Successfully obtain a system token valid for API requests. (https://developer.fabric.inc/v3/getting-started/authentication-v3/concepts, https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
Deliverables
- A valid system access token.
Steps
- Use Postman or cURL to make a POST request to the /token endpoint (e.g., {{authURL}}/v1/token). (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)
- Include grant_type=client_credentials, scope=s2s, client_id, and client_secret in the 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)
- Note the access_token, token_type (Bearer), 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)
- Understand that system tokens expire (default 10 minutes) and need to be regenerated. (https://developer.fabric.inc/v3/getting-started/authentication-v3/concepts, https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)
Familiarize with Developer Portal and Resources
Explore the Fabric Developer Portal for API references, guides, and tools. (https://developer.fabric.inc/home, https://developer.fabric.inc/home, https://developer.fabric.inc/v3/getting-started/api-guides/using-developer-portal)
Goals
- Become proficient in finding necessary documentation and support resources.
Deliverables
- Familiarity with Developer Portal structure and content.
Explore API References
Review the available API references for different Fabric modules (e.g., Product Catalog, Orders, Inventory, Cart & Checkout, Offers). (https://developer.fabric.inc/v3/getting-started/api-guides/api-references)
Goals
- Understand the scope and capabilities of each API.
Deliverables
- List of relevant API endpoints bookmarked.
Steps
- Visit the API References section on the Developer Portal. (https://developer.fabric.inc/v3/getting-started/api-guides/api-references)
Review Getting Started Guides
Read guides on 'Getting Started with fabric APIs' and 'Making your first API request'. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis, https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request)
Goals
- Understand basic API interaction protocols with Fabric.
Deliverables
- Notes on base URL and required headers.
Steps
- Understand base URL structure (https://api.fabric.inc/v3/{product}). (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
- Learn about required HTTP headers (x-fabric-tenant-id, Authorization, Content-Type). (https://developer.fabric.inc/v3/getting-started/api-guides/example, https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request)
Identify Support Channels
Know how to access Fabric support for assistance. (https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication, https://developer.fabric.inc/home)
Goals
- Be able to quickly find help when needed.
Deliverables
- Support contact information or links saved.
Steps
- Locate links to 'Contact Support' on the Developer Portal. (https://developer.fabric.inc/home, https://developer.fabric.inc/home)
Core Platform Integration Planning
Focuses on understanding Fabric's key modules, data models (like SKUs and other identifiers), and planning the integration architecture.
Competencies
Understanding E-commerce Data Models (Products, Orders, Inventory)
API Design and Integration Patterns
Data Mapping
Understand Key Fabric Modules and APIs
Gain a deeper understanding of Fabric's main e-commerce modules and their respective APIs.
Goals
- Identify which Fabric APIs are relevant to your business needs.
Deliverables
- List of Fabric APIs to be integrated.
- High-level understanding of each module's functionality.
Review Product Catalog Module
Understand how Fabric manages product information, attributes, categories, collections, variants, and bundles. (https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/product-catalog, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/create-category, https://developer.fabric.inc/v3/getting-started/copilot/feature-descriptions, https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/overview)
Goals
- Learn how to manage product data via API.
Deliverables
- Notes on Product Catalog API capabilities.
Steps
- Read Product Catalog overview and API documentation (e.g., creating attributes, adding products by ID or SKU). (https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/product-catalog, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/create-category, https://developer.fabric.inc/v3/getting-started/api-guides/identifiers, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/get-product-by-id, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/delete-product-by-sku)
Review Orders & Inventory Module
Understand how Fabric handles order lifecycle management, inventory tracking, fulfillment logic, locations, and networks. (https://developer.fabric.inc/v3/getting-started/copilot/feature-descriptions, https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/inventory, https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/orders, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/overview, https://developer.fabric.inc/v3/orders-and-inventory/homepage)
Goals
- Learn how to manage orders and inventory via API.
Deliverables
- Notes on Orders & Inventory API capabilities.
Steps
- Read Orders and Inventory overview, developer guides (Inventory Setup, Order Fulfillment), and API documentation. (https://developer.fabric.inc/v3/getting-started/copilot/feature-descriptions, https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/inventory, https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/orders, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/overview, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/inventory-setup, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-fulfillment, https://developer.fabric.inc/v3/orders-and-inventory/homepage)
Review Offers Module
Learn about Fabric's pricing and promotions engine, including price lists, promotions, and coupons. (https://developer.fabric.inc/home, https://developer.fabric.inc/v3/getting-started/copilot/feature-descriptions, https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/offers)
Goals
- Learn how to manage pricing and promotions via API.
Deliverables
- Notes on Offers API capabilities.
Steps
- Read Offers overview and API documentation (e.g., creating prices, promotions). (https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/offers, https://developer.fabric.inc/v3/offers/api-reference/offers/prices/create-batch-prices, https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/create-promotion)
Review Cart & Checkout Module
Understand how Fabric manages online shopping carts, pre-checkout tasks, and integrates with OMS. (https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/cart-checkout, https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/overview)
Goals
- Learn how to manage cart and checkout processes via API.
Deliverables
- Notes on Cart & Checkout API capabilities.
Steps
- Read Cart & Checkout overview and API documentation. (https://developer.fabric.inc/v3/getting-started/modules-and-feature-descriptions/cart-checkout, https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/overview)
Review Dropship Module (If Applicable)
Understand how Fabric enables dropshipping capabilities for retailers and suppliers. (https://developer.fabric.inc/v3/dropship/dropship-retailers/overview, https://developer.fabric.inc/v3/dropship/dropship-suppliers/orders/overview)
Goals
- Learn how to integrate with Dropship functionalities if required.
Deliverables
- Notes on Dropship API capabilities.
Steps
- Read Dropship overview for retailers and suppliers. (https://developer.fabric.inc/v3/dropship/dropship-retailers/overview, https://developer.fabric.inc/v3/dropship/dropship-suppliers/orders/overview)
Understand Fabric Identifiers
Learn how Fabric uses different identifiers like SKU, itemId, priceListId, inventoryId across its services. (https://developer.fabric.inc/v3/getting-started/api-guides/identifiers)
Goals
- Ensure correct use of identifiers in API calls and data mapping.
Deliverables
- Understanding of Fabric's identifier system.
- Identifier mapping sheet if necessary.
Subtasks
Review Identifiers Documentation
Study the 'Identifiers in fabric APIs' guide. (https://developer.fabric.inc/v3/getting-started/api-guides/identifiers)
Goals
- Distinguish between different types of Fabric identifiers.
Deliverables
- Summary of identifier usage per module.
Steps
- Understand the usage of sku, itemId, priceListId, and inventoryId in Product Catalog, Offers, Carts, Orders, and Inventory. (https://developer.fabric.inc/v3/getting-started/api-guides/identifiers, https://developer.fabric.inc/v3/getting-started/api-guides/identifiers, https://developer.fabric.inc/v3/offers/api-reference/offers/prices/create-price, https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/cart-actions/add-attributes, https://developer.fabric.inc/v3/getting-started/api-guides/identifiers, https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-fulfillment, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-and-inventory-import, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-exchange, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/create-inventory, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/update-inventory-by-adding-new-property)
Plan Integration Architecture
Decide on the overall architecture for integrating your systems with Fabric APIs.
Goals
- Define how data will flow between your systems and Fabric.
Deliverables
- High-level integration architecture diagram.
- Data mapping strategy document.
Identify Integration Points
Determine which of your existing systems (ERP, PIM, OMS, Storefront) will interact with Fabric APIs.
Goals
- Clearly define the touchpoints between existing infrastructure and Fabric.
Deliverables
- List of systems and their corresponding Fabric API integrations.
Steps
- Map business processes (e.g., product management, order fulfillment, inventory updates) to Fabric API functionalities.
Plan Data Synchronization Strategy
Decide on methods for data synchronization (e.g., real-time updates via webhooks, batch processes). (https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/api-authentication-data-sync)
Goals
- Ensure timely and accurate data consistency between systems.
Deliverables
- Chosen synchronization methods for different data types.
Steps
- Review Fabric's webhook capabilities for relevant modules (e.g., Product Catalog, Orders, Inventory). (https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/list-of-webhook-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-orders-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-inventory-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-products-events)
Define Data Mapping
Map data fields between your systems and Fabric's data models.
Goals
- Ensure accurate data translation between systems.
Deliverables
- Detailed data mapping documents for key entities like products, orders, customers.
Steps
- Create spreadsheets or documents detailing field-to-field mappings, transformations, and default values.
Development & Implementation
Involves writing code to interact with Fabric APIs, setting up webhooks, and managing configurations.
Competencies
API Client Development (e.g., using cURL, Postman, or SDKs)
Webhook Handling
Environment Configuration Management
Develop API Client/Integration Layer
Build the software components that will communicate with Fabric APIs.
Goals
- Create a robust and reliable integration layer.
Deliverables
- Functional code for API interactions.
- API client library/module.
Set Up Development Environment
Prepare your development environment with necessary tools and libraries.
Goals
- Establish a working environment for Fabric integration development.
Deliverables
- Configured development environment.
Steps
- Install API testing tools like Postman. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
- Set up project structure for integration code (e.g., version control, IDE).
Implement Core API Calls
Start implementing API calls for core functionalities based on your integration plan (e.g., creating a product, placing an order).
Goals
- Successfully execute basic CRUD operations against Fabric APIs.
Deliverables
- Working examples of key API calls.
Steps
- Use the 'Make your first API request' guide for an example (e.g., Create Attribute in Product Catalog). (https://developer.fabric.inc/v3/getting-started/api-guides/example, https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request)
- Ensure proper header inclusion: x-fabric-tenant-id, Authorization (Bearer token), Content-Type. (https://developer.fabric.inc/v3/getting-started/api-guides/example, https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request)
- Implement robust error handling for API responses, including success and error codes.
Implement Authentication Renewal
Implement logic to automatically renew access tokens before they expire. (https://developer.fabric.inc/v3/getting-started/authentication-v3/concepts, https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)
Goals
- Ensure uninterrupted API access.
Deliverables
- Automated token renewal mechanism.
Steps
- Track token expiry time (expires_in value). (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)
- Re-authenticate using Client Credentials flow when needed before token expiration. (https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication)
Configure and Handle Webhooks
Set up webhooks in Fabric to receive real-time notifications for events in different modules. (https://developer.fabric.inc/v3/platform/settings/webhooks/adding-a-webhook)
Goals
- Enable real-time data synchronization and event-driven workflows.
Deliverables
- Configured webhooks in Fabric.
- Webhook handling service/endpoints in your system.
- Documentation for webhook processing logic.
Identify Necessary Webhook Events
Determine which events from Product Catalog, Orders, or Inventory require webhook notifications. (https://developer.fabric.inc/v3/platform/settings/webhooks/adding-a-webhook)
Goals
- Subscribe only to relevant events to avoid unnecessary traffic.
Deliverables
- List of webhook events to subscribe to.
Steps
- Review list of available events for Product Catalog (e.g., pim:product.item:created, pim:node.category:updated). (https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-products-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-products-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-products-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-products-events)
- Review list for Orders (e.g., ORDER_CREATE, ALLOCATION_CREATE_SHIP). (https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-orders-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-orders-events, https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/overview)
- Review list for Inventory (e.g., INVENTORY_CREATE, INVENTORY_NETWORK_UPDATED). (https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-inventory-events, https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-inventory-events)
Implement Webhook Listener Endpoint
Develop an endpoint in your system to receive and process incoming webhook payloads from Fabric.
Goals
- Reliably receive and process Fabric webhook notifications.
Deliverables
- Deployed and tested webhook listener endpoint.
Steps
- Ensure the endpoint can handle POST requests with JSON payloads. (https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/list-of-webhook-events)
- Secure the endpoint (e.g., using the API key provided during webhook setup) and validate incoming requests.
Configure Webhooks in Fabric Copilot
Add webhook subscriptions via the Fabric Copilot interface. (https://developer.fabric.inc/v3/platform/settings/webhooks/adding-a-webhook)
Goals
- Successfully subscribe your listener to Fabric events.
Deliverables
- Active webhook subscriptions in Copilot.
Steps
- Navigate to Settings > Developer Tools > Webhooks. (https://developer.fabric.inc/v3/platform/settings/webhooks/adding-a-webhook)
- Click 'Add Webhook', provide a name, your listener endpoint URL, an API key (for securing your endpoint), and select the desired events. (https://developer.fabric.inc/v3/platform/settings/webhooks/adding-a-webhook)
- Test the webhook from Copilot to ensure your listener receives the test event. (https://developer.fabric.inc/v3/platform/settings/webhooks/testing-a-webhook)
Manage Data Import/Export (If Applicable)
Perform bulk data operations using Fabric's import/export functionalities if needed for initial data load or large updates.
Goals
- Efficiently manage large datasets during onboarding or for ongoing synchronization.
Deliverables
- Successful data import/export operations.
- Documentation of import/export processes.
Prepare Data Files (CSV/JSONL)
Format your data according to Fabric's templates for items, bundles, attributes, categories, collections (Product Catalog) or inventory, orders (OMS). (https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/bundles/importing-bundles, https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/importing-items, https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/importing-product-attributes, https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/categories/importing-categories, https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/collections/importing-collections, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-and-inventory-import, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-and-inventory-import)
Goals
- Ensure data files are correctly formatted for successful import.
Deliverables
- Validated data files ready for import.
Steps
- Download templates from Copilot or generate via API (e.g., Product Catalog template generation). (https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/files/generate-the-import-template, https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/files/retrieve-import-template)
- Ensure data adheres to formatting guidelines (e.g., SKU requirements, date formats, action codes like UPSERT, CREATE). (https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/bundles/importing-bundles, https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/importing-product-attributes, https://developer.fabric.inc/v3/product-catalog/data-ingestion)
Use Import APIs/Copilot UI
Upload data files and monitor import jobs.
Goals
- Successfully load data into Fabric.
Deliverables
- Confirmation of data import completion.
Steps
- For Product Catalog: Use Files and Jobs API (e.g., create file object, upload, monitor job status via product-jobs). (https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/files/create-file-object-and-get-file-upload-location, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/jobs/get-jobs-related-to-products, https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/products---files-and-jobs-api)
- For Orders/Inventory: Use OMS Imports (oms-imports) or Inventory Imports (inventory-imports) endpoints to upload files and check status. (https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-and-inventory-import, https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/imports/get-uploaded-file-status-and-details)
- Check import status and error reports in Copilot (Background Jobs for Product Catalog, Activity Log for OMS/Inventory) or via API. (https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/background-jobs/background-jobs, https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/background-jobs/viewing-background-jobs-history, https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/activity-log, https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/activity-log)
Testing, Go-Live & Post-Launch
Covers testing the integration thoroughly, preparing for and executing the go-live, and post-launch monitoring.
Competencies
Integration Testing
Deployment Management
System Monitoring and Alerting
Comprehensive Integration Testing
Test all aspects of the Fabric integration to ensure functionality, reliability, and performance.
Goals
- Validate that the integration meets all business requirements and works as expected.
Deliverables
- Test plans and execution reports.
- List of resolved issues.
Develop Test Cases
Create test cases covering all integrated scenarios (e.g., product creation, order placement, inventory updates, webhook notifications).
Goals
- Ensure thorough test coverage of the integration.
Deliverables
- Documented test cases.
Steps
- Cover successful paths, edge cases, and error handling scenarios.
Execute End-to-End Tests
Perform tests that simulate real user flows across your systems and Fabric.
Goals
- Verify the complete workflow from start to finish.
Deliverables
- End-to-end test results.
Steps
- Test data synchronization accuracy and timeliness.
- Verify webhook event delivery and correct processing by your listener.
Performance and Load Testing (If Applicable)
Test the integration under expected and peak load conditions.
Goals
- Ensure the integration can handle production-level traffic.
Deliverables
- Performance test report.
Steps
- Identify and address any performance bottlenecks in the integration layer or API interactions.
Prepare for Go-Live
Plan and prepare for the deployment of the Fabric integration to the production environment.
Goals
- Ensure a smooth transition to the live environment with minimal disruption.
Deliverables
- Go-live checklist.
- Rollback plan.
- Communication plan.
Finalize Production Configuration
Ensure all configurations (API keys, webhook URLs, environment variables) are set and verified for the production environment.
Goals
- Prevent configuration errors during deployment.
Deliverables
- Verified production configuration settings.
Steps
- Double-check tenant IDs and channel IDs if applicable for production.
- Securely store production API credentials.
Data Migration (If Applicable)
Plan and execute any final data migration to the production Fabric environment.
Goals
- Ensure all necessary data is available in production at go-live.
Deliverables
- Successful data migration report.
Steps
- Follow data import best practices, potentially performing a dry run if possible. (https://developer.fabric.inc/v3/product-catalog/data-ingestion)
Develop Rollback Plan
Prepare a detailed plan to revert to the previous state in case of critical issues during or immediately after go-live.
Goals
- Minimize downtime and impact in case of go-live failure.
Deliverables
- Documented and tested rollback procedures.
Steps
- Identify rollback triggers and responsibilities.
Execute Go-Live
Deploy the integration to production and switch over to the new system.
Goals
- Successfully launch the Fabric integration into production.
Deliverables
- Live integration.
- Go-live communication sent to stakeholders.
Deploy Integration Code
Push the final, tested integration code to the production environment.
Goals
- Make the integration live.
Deliverables
- Deployment confirmation.
Steps
- Follow established deployment procedures.
Switch Over Systems
Activate the Fabric integration and decommission old systems/processes as planned.
Goals
- Transition operations to the new Fabric-integrated workflow.
Deliverables
- Confirmation of system switch-over.
Steps
- Execute cutover plan, potentially during a low-traffic window.
Initial Production Monitoring
Closely monitor the integration immediately after go-live for any unexpected issues.
Goals
- Quickly identify and resolve any post-launch problems.
Deliverables
- Initial stability report.
Steps
- Check API call success rates and error logs.
- Monitor webhook delivery and processing in Fabric Copilot and your listener logs. (https://developer.fabric.inc/v3/platform/settings/webhooks/managing-events-and-logs)
Post-Launch Monitoring & Optimization
Continuously monitor the integration's performance, address any issues, and identify areas for optimization.
Goals
- Maintain a stable and efficient integration.
- Iteratively improve the integration based on performance and evolving business needs.
Deliverables
- Monitoring dashboards and reports.
- Regular performance reviews.
- Implemented optimizations and bug fixes.
Set Up Monitoring and Alerting
Implement robust monitoring for API calls, webhook status, and data consistency. Utilize Fabric's operational alerts if applicable. (https://developer.fabric.inc/v3/platform/home/alerts/alerts-overview)
Goals
- Proactively identify and respond to integration issues.
Deliverables
- Configured monitoring tools and alerts.
Steps
- Configure alerts for critical errors (e.g., high API error rates, webhook failures) or performance degradation. (https://developer.fabric.inc/v3/platform/home/alerts/creating-alerts)
- Use Fabric Copilot's Alerts feature for platform-level issues and to subscribe to relevant notifications. (https://developer.fabric.inc/v3/platform/home/alerts/alerts-page, https://developer.fabric.inc/v3/platform/home/alerts/managing-alerts)
Regularly Review Performance
Analyze logs and performance metrics to identify any recurring issues or areas for improvement.
Goals
- Ensure ongoing stability and efficiency.
Deliverables
- Periodic performance review meeting minutes and action items.
Steps
- Check webhook logs in Fabric Copilot for delivery status and errors. (https://developer.fabric.inc/v3/platform/settings/webhooks/managing-events-and-logs)
- Analyze API response times and error rates.
Plan for Updates and Maintenance
Stay informed about Fabric API updates and plan for any necessary maintenance or upgrades to your integration.
Goals
- Keep the integration compatible and secure.
Deliverables
- Integration maintenance schedule.
Steps
- Review Fabric release notes regularly for API changes or new features. (https://developer.fabric.inc/v3/release-notes/feedback-contact)
Security & Compliance
Ensuring that the integration adheres to security best practices and relevant compliance standards.
Competencies
Data Security Principles (Encryption, Access Control)
Compliance Standards (e.g., PCI DSS, SOC 2)
Secure Software Development Lifecycle
Review Fabric's Security and Compliance
Understand Fabric's security measures, data protection policies, and compliance certifications.
Goals
- Ensure Fabric's security posture meets your organization's requirements.
Deliverables
- Confirmation of Fabric's security and compliance alignment.
- Documentation of reviewed security features.
Examine Data Security Documentation
Review Fabric's documentation on data encryption (at rest and in transit), access control (RBAC, MFA), and tenant isolation. (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance, https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance, https://developer.fabric.inc/v3/getting-started/data-security)
Goals
- Understand how Fabric protects platform and customer data.
Deliverables
- Summary of Fabric's data protection measures.
Steps
- Understand how Fabric protects customer data and credentials (e.g., use of TLS for data in transit, AES-256 for data at rest, bcrypt for hashing passwords). (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance, https://developer.fabric.inc/v3/getting-started/data-security)
Check Compliance Certifications
Verify Fabric's compliance certifications such as SOC 2 Type II, PCI DSS (SAQ-A). (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance)
Goals
- Confirm Fabric meets relevant industry compliance standards.
Deliverables
- List of verified Fabric compliance certifications.
Steps
- Request compliance certificates or attestations if needed and available. (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance)
Implement Secure API Key Management
Ensure secure storage and handling of API keys (Client ID, Client Secret).
Goals
- Prevent unauthorized access to Fabric APIs through compromised credentials.
Deliverables
- Secure mechanism for API key storage and rotation policy.
Store Credentials Securely
Use a secure vault or secrets management system for API Client ID and Client Secret. (https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis)
Goals
- Protect API credentials from exposure.
Deliverables
- API credentials stored in a secure system.
Steps
- Avoid hardcoding credentials in applications or version control.
Implement Credential Rotation Plan
Plan for periodic rotation of API client secrets to limit the impact of potential compromises.
Goals
- Reduce the risk associated with long-lived credentials.
Deliverables
- Documented credential rotation schedule and procedure.
Steps
- Establish a process for generating and updating client secrets.
Ensure Secure Data Handling in Integration
Implement security best practices within your integration code for handling sensitive data.
Goals
- Protect data as it flows through the integration, maintaining confidentiality and integrity.
Deliverables
- Secure integration code adhering to best practices.
Input Validation
Validate all data received from Fabric APIs and data sent to Fabric APIs to prevent injection attacks or processing of malformed data.
Goals
- Enhance the robustness and security of the integration.
Deliverables
- Implemented input validation mechanisms.
Steps
- Sanitize inputs and validate data types and formats.
Error Handling and Logging
Implement secure error handling that doesn't expose sensitive information in logs or error messages.
Goals
- Prevent accidental disclosure of sensitive data through logs.
Deliverables
- Secure error handling and logging implemented.
Steps
- Ensure logs are stored securely and access is restricted to authorized personnel only.
Configure Access Control (RBAC)
Utilize Fabric's Role-Based Access Control (RBAC) to manage user permissions within Copilot and for API access if applicable. (https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control)
Goals
- Enforce the principle of least privilege for all users and system integrations.
Deliverables
- Appropriate roles assigned to users and API apps.
- Documentation of RBAC configuration.
Review Available Roles
Understand the different roles available in Fabric (e.g., Admin, Editor, Viewer, specific product roles like Product Catalog Editor, Orders & Inventory Editor). (https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control, https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control-products-roles, https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control-orders-roles, https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control-offers-roles)
Goals
- Understand the permission levels associated with each role.
Deliverables
- Role definition summary.
Steps
- Map user responsibilities within your organization to the appropriate Fabric roles.
Assign Roles to API System Apps
Assign the appropriate role to the System App used for API integration, ensuring it has only necessary permissions. (https://developer.fabric.inc/v3/platform/settings/api-apps/creating-system-app)
Goals
- Limit the API key's capabilities to only what is required.
Deliverables
- System App assigned with the least privileged role.
Steps
- Select the least privileged role that allows the integration to perform its designated functions (e.g., if only reading product data, assign a viewer-like role if available for APIs, or a specific product editor role if creation/updates are needed). (https://developer.fabric.inc/v3/platform/settings/api-apps/creating-system-app)
Review Incident Response and Vulnerability Management
Understand Fabric's incident response procedures and vulnerability management program. (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance, https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance)
Goals
- Be aware of how Fabric handles security incidents and vulnerabilities that might affect your integration.
Deliverables
- Familiarity with Fabric's security operations and communication channels for security events.
Understand Incident Response SLA
Review Fabric's standard SLA for incident response, including notification times and resolution efforts. (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance)
Goals
- Know what to expect in terms of communication and response during a security incident.
Deliverables
- Notes on Fabric's incident response policy.
Steps
- Identify how Fabric communicates security incidents to customers.
Be Aware of Vulnerability Management
Understand Fabric's approach to vulnerability scanning (e.g., SAST), rating, and remediation timelines. (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance, https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance)
Goals
- Be confident in Fabric's processes for identifying and addressing security vulnerabilities.
Deliverables
- Understanding of Fabric's vulnerability management practices.
Steps
- Note how Fabric incorporates security into its CI/CD pipeline and performs periodic security audits. (https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance, https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance)