Loading
Feature degradation | Gmail Email delivery failureRead More
Get Started with Communications, Media, and Energy & Utilities (CME)...
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Omnichannel Web APIs

            You are here:

            1. Salesforce Help
            2. Docs
            3. Communications, Media, and Energy & Utilities Managed Package

            Omnichannel Web APIs

            Vlocity Omnichannel Web APIs are enterprise-scale web application programming interfaces (APIs) that extend Vlocity Industry Cloud Application functionality to other applications, devices, and channels. These APIs operate at a higher level of functionality than the object level Salesforce REST APIs, which makes them easier for web and mobile developers to use. They also provide better overall performance for devices interacting with Vlocity Apps over the Internet because more is achieved with each request and response. Because they are built on the Force.com platform using Apex REST, they provide the reliable, fine-grained security that you expect from the leading CRM platform.

            Vlocity Omnichannel Web APIs can be grouped into the following major categories:

            • Platform APIs: Client applications use Platform APIs to access other data and functionality from Vlocity Industry Cloud applications. They provide programmatic access to customer data, such as profile attributes and customer stories, campaign data for call lists and associated members and documents, as well as access to system extensions such as the Vlocity Action framework.

            • Cart-Based APIs for Industries CPQ: Client applications use Cart-Based APIs for selecting and ordering products and services. They provide a layer of abstraction between the client app developers and the CPQ developers who are configuring and customizing the underlying CPQ logic.

            • Digital Commerce (Cacheable) APIs: The Digital Commerce SDK uses Digital Commerce APIs to develop consumer-facing web and mobile applications to shop for products and services.

            • Omnistudio Data Mapper APIs: Integration developers use Data Mapper APIs to create JSON interfaces for extracting data from Salesforce objects or posting data to Salesforce objects. Data Mappers are often used in conjunction with OmniScripts but can be used by any REST client application.

            • Government APIs: Vlocity Government APIs are defined for community users to view housing listings and to express interest in them. The APIs provide a layer of abstraction between the web application and the Salesforce data model.

            Use Vlocity Omnichannel Web APIs to expose specific Vlocity innovations in your mobile or custom web applications. Omnichannel Web APIs are available in all industry packages, providing access to customer stories, profiling attributes, call lists (campaigns), and Vlocity Actions.

            Vlocity Omnichannel Web APIs augment the many other APIs that the Salesforce platform provides. Vlocity Omnichannel Web APIs do not replace the Salesforce APIs. Many client applications will leverage some native Salesforce APIs in addition to Vlocity Web APIs to build a complete application. In addition, companies deploying Vlocity Industry Cloud Apps with Salesforce can use Apex REST to design additional Web APIs.

            • Base URL Structure and Namespaces
              All URLs in Vlocity Omnichannel Web APIs are relative to https://instance.salesforce.com/services/apexrest/namespace/
            • Omnichannel API Versioning
              Vlocity Omnichannel Web API URLs contain a version number (/v1, /v2, or /v3) after the base path. For example, https://instance.salesforce.com/services/apexrest/namespace/vx/….
            • Omnichannel API Authentication and Security
              Apex REST supports two authentication mechanisms: OAuth 2.0 or Session ID. Usually, you will use Session ID authentication only for testing purposes during development. OAuth 2.0 is recommended. For more information, see the following topics in the Force.com REST API Developer Guide:
            • Omnichannel API Limits
              To maintain optimum performance and ensure that the Force.com API is available to all customers, Salesforce imposes two types of API limits: concurrent API request limits and total API request limits. When a call exceeds a request limit, an error is returned. The actual limit depends on the type of Salesforce edition org you are using, the number of user licenses you have purchased, and the number of additional API calls you may have purchased.
            • Omnichannel API Response Status Codes
              Vlocity Apex REST APIs return the standard HTTP response status codes.
            • Which Salesforce API to Use When
              Salesforce APIs provide programmatic access to information. Vlocity Omnichannel Web APIs augment the many other APIs that the Salesforce platform provides. Many client applications will leverage some native Salesforce APIs in addition to Vlocity Web APIs to build a complete application.
             
            Loading
            Salesforce Help | Article