Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Aria for Salesforce > Aria for Salesforce 2 > Salesforce Integration > Aria for Salesforce SDKs

Aria for Salesforce SDKs

Table of contents

Overview

The Aria for Salesforce SDK comprises the Aria Core APIs and the Aria Admintools APIs. These Aria for Salesforce SDKs are Apex wrappers around the Aria APIs that give a Salesforce developer easy access to the Aria APIs from within Salesforce. The Aria for Salesforce app needs to be installed to use the Apex-wrapped Aria APIs. The Aria for Salesforce SDK is built on the Force.com platform. Note that 64 out of about 150 Core APIs are wrapped. With these Aria for Salesforce Apex wrappers:

  • There is no need to explicitly make callouts to Aria’s system. The callouts are encapsulated as Apex classes that can be used out of the box. This makes custom development/configuration on Salesforce for integrating with Aria quicker, easier, and more seamless.
  • There is no need to parse and read responses from callouts made to Aria’s system. The response is encapsulated as Apex classes and methods. Users can quickly use the Apex class/methods of the SDK to read responses in the Aria for Salesforce app format.

The methods in the SDK are named after the Aria API methods, making it easier to identify the Aria for Salesforce app method that should be used to make a callout to a specific Aria API method. The Aria for Salesforce SDK is included in the Aria for Salesforce app. No special installation or configurations are required to install the Aria for Salesforce SDK. Once the user installs the Aria for Salesforce app, the Aria for Salesforce SDK is available to the user in his or her Salesforce instance. Please see the Salesforce Installation and Configuration for more information.

Once the Aria for Salesforce app is installed, the following Apex classes list the Core and Admintools APIs that are currently available in the Aria for Salesforce SDK. 

  • AriaServiceGeneral.cls
  • AriaAdminToolServiceGeneral.cls​

The Aria for Salesforce SDK does not include all of the Aria APIs. The Aria APIs are added to the SDK incrementally with every Salesforce release.

Additional Help

Once Aria users install the Aria for Salesforce app, there are SDK help files available from within Salesforce’s help documentation (also below). The SDK help file static resource is a compressed file named "AriaSdkHelpDocs". You can navigate to Salesforce and click on this static resource to view or download the compressed file.

  • Aria-Apex Structure_Core_API_SDK
    This file contains the list of request/response Apex methods to be used as request/response parameters for the SDK calls to Aria Core APIs.
  • Aria-Apex Structure_Admintools_API_SDK
    This file contains the list of request/response Apex methods to be used as request/response parameters for the SDK calls to the Aria Admintools APIs.
  • SFDC_SDK_Implementation_SampleCode
    This file contains information about the SDK and provides sample code on how to use the SDK in the Aria for Salesforce app.
You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.