DOCSEARCHbyAlgolia
Submit Docs

Amplience Developer Documentation

website·Indexed 30 days ago

https://amplience-developer-portal-develop.vercel.app/developers/

Developer guides and API references for Amplience CMS, featuring the GraphQL Management API for asset management and the GraphQL Content Delivery API. Includes documentation on account management, SSO configuration, permissions, roles, and the use of Amplience credits for AI services.

Tokens
352.8K
Snippets
1.2K
Records
2.7K
Agent score
75%

What's inside Amplience

  1. Overview of Amplience CMS and Salesforce Commerce Cloud (SFCC) Integration

    The Amplience CMS integration for Salesforce Commerce Cloud (SFCC) is designed to streamline the connection between the CMS and SFCC storefronts. It reduces the manual setup required by developers and simplifies the configuration process for users managing SFCC environments.

  2. Overview of the Amplience CMS development workflow

    To get started with Amplience CMS, developers typically follow a four-step workflow to move from content modeling to frontend rendering. Using a banner as an example, the process involves:

    1. Model: Create a content type schema using the schema editor and register it in the CMS.
    2. Create: Use the content type to create a content item (e.g., adding a background image) and assign a delivery key.
    3. Publish: Publish the content to make it available via the Content Delivery API.
    4. Consume: Use the Content Delivery SDK to retrieve the published content by its delivery key and render it in the browser.

  3. Overview of Amplience CMS Extensions

    Extensions are web applications used to expand the functionality of Amplience CMS. They are developed using the Amplience CMS Extensions SDK (available on GitHub) and support JavaScript and TypeScript, allowing the use of libraries like React. Extensions must be served over HTTPS, though localhost is permitted for local development. To ensure a consistent user experience, developers should follow the Extensions Style Guide.

  4. Introduction to Amplience CMS Webhooks

    Webhooks allow Amplience CMS to automatically send data to third-party systems when specific events occur in the CMS (e.g., creating/updating content or scheduling editions). Webhooks are associated with a single Amplience CMS hub and are used to integrate external software, such as e-commerce systems, with the CMS.

  5. Overview of Workforce extensions

    Workforce extensions allow developers to create custom actions that integrate with 3rd party products or implement custom business logic. These actions make external data available for use within automation flows. Extensions are organized into folders within the Integrations section of the Actions Library; a single extension can contain multiple actions.

  6. Overview of Amplience CMS webhook integrations

    Webhooks in Amplience CMS allow you to automatically notify users or synchronize data whenever content items are created or updated. Supported integrations include:

    • Slack: Post messages to channels upon content creation or updates.
    • Zapier: Trigger Zaps based on user actions within the CMS.
    • Algolia: Sync search indexes via a customizable webhook.
    • Twilio: Send instant SMS notifications when content is published.
    • Constructor.io: Sync new content data to the Constructor.io dashboard using a customizable webhook.

  7. Overview of Amplience CMS member and team management

    Account management allows administrators to control access to Amplience CMS hubs and repositories.

    • Members: Users within an organization. A user must be an 'active member' to access hubs and repositories.
    • Teams: Groups of members used to control access at a group level.

    Permissions:

    • Organization Administrators: Can perform all account management actions.
    • Hub Admins: Can perform a subset of organization admin actions.

  8. Overview of Amplience Virtual Staging

    Virtual staging is a feature in Amplience that allows developers and content creators to work with and deliver unpublished content and media. It is primarily used to provide unpublished data to visualizations and previews before it is officially published to a production environment. Virtual staging covers three main areas: dynamic content delivery via the CMS, retrieval of unpublished assets and media, and access control through authorization mechanisms such as whitelists, preview keys, and client-side signing.

  9. Overview of the Amplience CMS and Salesforce Marketing Cloud (SFMC) integration

    The Amplience CMS SFMC integration allows users to reuse content between a website and emails. When a content item of a supported content type is published in Amplience CMS, the integration automatically creates a corresponding HTML content block in the SFMC Content Builder.

    Integration Workflow:

    1. Trigger: A content item is published from the Amplience CMS production view, generating a Snapshot-published webhook event.
    2. Filtering: The integration checks if the published item belongs to a supported content type.
    3. Rendering: The integration requests HTML for the content item from the Content Rendering Service using a pre-configured Handlebars template.
    4. Creation: An HTML content block is created in a specified SFMC folder.
      • Name: Set to the name of the content item (if a block with the same name exists, the creation date/time is appended for uniqueness).
      • Customer Key: Set to the Amplience content item ID.
      • Content: Set to the HTML returned by the Content Rendering Service.

  10. Overview of Personal Access Tokens (PATs)

    Personal Access Tokens (PATs) are long-lived tokens used to authorize access to the Content Management and GraphQL Management APIs, as well as the Amplience CLI tool. They serve as an alternative to tokens generated via clientID and secret.

    Key characteristics:

    • Scope: Tokens are created per user and per organization.
    • Permissions: A PAT is granted only the permissions of the user who created it.
    • Lifespan: PATs do not expire, though they can be deleted.
    • Ownership: Users can only create tokens for themselves; they cannot create tokens on behalf of others.

  11. Overview of the SEO Assistant extension

    The SEO Assistant is a content field extension for Amplience CMS that uses AI to generate contextual SEO title and description tags. It helps search engines understand and rank pages by providing essential meta information. Key features include:

    • AI-generated meta titles and descriptions based on content context.
    • Scoring and insights based on SEO best practices (Length, Readability, Accessibility).
    • SERP (Search Engine Results Page) previews for desktop and mobile.
    • Keyword generation from existing content.
    • Integration with the Generative rich text editor to create keyword-optimized content.

    Note: This is an Amplience labs preview and is provided as-is. Using the 'Generate' or 'Scoring and insights' buttons consumes one Amplience credit per use.

  12. Overview of Just in Time (JIT) provisioning for Dynamic Content

    Just in time provisioning allows organization administrators to set initial permissions for Dynamic Content user accounts at the moment of creation. This ensures users have immediate access to the platform without waiting for manual permission assignments after the account is active.