Popular Search how tohow to useagenthowdatarestbatchcustomskyvvaadapter
View Categories

Inbound API V4/integrate

Introduction #

To retrieve data from both the HTTP header and query parameters for the Inbound API V3/integrate using the SKYVVA integration application, the user can employ the following steps:

1. HTTP Header Data Retrieval:

  • Utilize the appropriate methods provided by the SKYVVA integration application to access the HTTP header of the incoming request.
  • Extract the required information from the header, such as authentication tokens, content types, or custom headers specific to your integration business scenario.

2. Query Parameter Data Retrieval:

  • Similarly, leverage the functionalities within the SKYVVA integration application to access and process the query parameters appended to the incoming request URL.
  • Extract relevant data from the query parameters, which include filters, search criteria, or additional metadata needed for processing the API call.

3. Integration Configuration:

  • Configure the Inbound API V4/integrate endpoint within the SKYVVA integration application to handle incoming requests, specifying the appropriate parameters and headers required for data retrieval.
  • Define mapping transformations between the retrieved data and the integration workflow within Salesforce.

By effectively fetching data from both the HTTP header and query parameters using the capabilities of the SKYVVA integration application, the user can ensure comprehensive access to the information needed to facilitate seamless integration processes.

Case: Fetching the data from the HTTP header and Query Parameter for the Inbound API Inbound API V3/integrate #

To standardize the passing of HTTP headers and query parameters through the API, here we establish a syntax and naming convention for clients to adhere to. Clients are required to prefix their HTTP headers and query parameters with “_CUSTOM_xxx“. Only fields that begin with this specified prefix will be parsed and included in the message.

Here’s an example of how it should be formatted:

  • The client intends to include custom data in the HTTP header, there is a prefix for each custom field with “_CUSTOM_xxx“.
  • For instance, the client wants to transmit a custom field named “Authorization“.

For query parameters:

  • Similarly, the client needs to pass custom parameters through the query string, they should prefix each parameter with “_CUSTOM_xxx“.
  • For instance, if a client wishes to include a custom query parameter named “filter”, they should prefix it as “_CUSTOM_MyParam“.

By following this established convention, clients can ensure that their custom HTTP headers and query parameters are properly recognized and processed by the API, enhancing interoperability and facilitating seamless integration with the SKYVVA integration application.

  • Create integration and inbound interface

  • Do mapping

  • Here is the header parameter in Postman

  • Here is the query parameter in Postman

  • Send data to Salesforce

<?xml version="1.0" encoding="UTF-8"?>
<ROOT>
<AccountTestV3>
<AccountNumber>20002</AccountNumber>
<Name>TestAccount1</Name>
<BillingCountry>Cambodia2</BillingCountry>
<BillingCity>PhnomPenh2</BillingCity>
<Account_ID>101</Account_ID>
<Description>Test description ACCOUNT object</Description>
<ContactTestV3>
<Cont_ID>201</Cont_ID>
<LastName>TestContact_04</LastName>
<FirstName>DContact2</FirstName>
<Email>Dtest.2019_201@gmail.com</Email>
<Phone>301</Phone>
<Description>Test description CONTACT object</Description>
<CaseTestV3>
<Subject>TestCase Agent-04</Subject>
<SuppliedPhone>401</SuppliedPhone>
<status>Failed</status>
<Case_Id>2001</Case_Id>
<Description>Test description CASE object</Description>
</CaseTestV3>
</ContactTestV3>
</AccountTestV3>
</ROOT>

  • Check the result

[su_box title=”Note” box_color=”#2a8af0″ title_color=”#000000″]The user must follow our rule when they want to pass the HTTP header or query parameter to the V3/ or V4/integrate API. For the HTTP header, the prefix is __SKYVVA_HEADER_xxx and the query parameter is __SKYVVA__QUERYPARAM_xxx. We store these fields in the message with specific names __SKYVVA_HEADER_xxx and __SKYVVA__QUERYPARAM_xxx. The value needs to be repeated in all messages that we create from the API call. These values are coming per API call, so all messages we create per API call must contain these values. [/su_box]

Summary #

NOw user understands the Inbound API V4/integrate feature of the SKYVVA application enables data retrieval from HTTP headers and query parameters. This functionality streamlines accessing and integrating external data sources, enhancing efficiency and facilitating seamless communication between systems.