DCKAP Integrator
Getting StartedIntegrator StatusRoadmapRelease Notes
  • Overview
    • Enterprise Integration Platform
    • What is DCKAP Integrator?
    • Integrator Architecture
    • Integrator Security
  • GETTING STARTED
    • Quick Start Guide
    • New User Registration
      • Available Plans
    • Integrator Dashboard
    • Analytics
  • User Guide
    • The Basics
    • Account Management
      • User Groups
      • Account Settings
      • Two-Factor Authentication
    • Projects
      • Add New Project
      • Managing Projects
      • Transfer Project Ownership
    • API Access Keys
    • Project Invitations
    • Help and Support
      • Raise a Ticket
      • Visibility and Collaborators
      • Help and Support - A Quick Overview
    • Exchange
  • PROJECT MANAGER
    • Integrations
      • Add New Pipe
      • Flows and Handlers
      • Mapping and Modifiers
      • Advanced Modifiers
      • Advanced Scheduler
    • Workflows
      • Flow Builder
      • Snippets
      • Actions
        • API Call
        • Console
        • Decision
        • Loop
        • Detail Logger
        • Error Logger
        • Code Runner
        • Formatter
        • Notification
        • Snippet
        • Return
        • Sleep
      • Mock Data
      • FAQs
    • Systems
      • Credentials
      • API Manager
        • API Components
        • Test API
      • Private Systems
      • Authentication Types
        • OAuth 2.0
    • Logs
    • Project Settings
    • Project Analytics
    • Advanced
      • Flows
    • Project Documents
  • TECHNICAL GUIDE
    • Flows & Handlers
      • Add New Flow
      • Simulator
      • Flows: Best Practices
      • Flows: Use Cases
      • Timezone Converter Handler
      • Supported Timezones
    • API and Mapping
  • Tutorials
    • Create a new Integration Pipe
    • Create a new Flow
    • How to Map data?
    • Working with Modifiers
    • Managing User Groups
    • How to use DCKAP Integrator Dynamic URL's?
  • API Documentation
    • Quick Start
    • Projects API
    • Credentials API
    • Templates API
    • Posting and Reading XML data via DCKAP Integrator
    • Commonly used APIs
  • Others
    • Product Roadmap
      • Past Roadmaps
    • Release Notes
      • 4.4.0 April 29, 2025
      • 4.3.0 February 25, 2025
      • 4.2.0 December 19, 2024
      • 4.0.0 August 29, 2024
      • 3.4.8 May 27, 2024
      • 3.4.7 March 14, 2024
      • 3.4.6 January 4, 2024
      • 3.4.5 October 18, 2023
      • 3.4.4 May 16, 2023
      • 3.4.3 March 1, 2023
      • 3.4.2 December 20, 2022
      • 3.4.1 October 4, 2022
      • 3.4.0 August 10, 2022
      • 3.3.6 July 20, 2022
      • 3.3.5a June 23, 2022
      • 3.3.5 May 26, 2022
      • 3.3.4 March 31, 2022
      • 3.3.3 Feb 4, 2022
      • 3.3.2 November 24, 2021
      • 3.3.1 October 22, 2021
      • 3.3.0 August 28, 2021
      • 3.2.7 June 18, 2021
      • 3.2.6 May 11, 2021
      • 3.2.3 and 3.2.4 March 8, 2021
      • 3.2.2 Dec 24, 2020
      • 3.2.1 Nov 12, 2020
      • 3.2.0 - October 7, 2020
      • 3.1.10 - September 16, 2020
      • 3.1.9 - September 3, 2020
      • 3.1.8 - August 15, 2020
      • 3.1.7 - July 19, 2020
      • 3.1.6 - June 21, 2020
      • 3.1.5 - May 15, 2020
      • 3.1.4 - April 27, 2020
      • 3.1.3.0 - April 20, 2020
      • 3.1.3 - April 8, 2020
      • 3.1.2 - March 26, 2020
      • 3.1.1 - March 13, 2020
      • 3.1.0 - March 10, 2020
Powered by GitBook
On this page
  • Step 1: API Manager
  • Step 2: Flows - API Call Handler
  • Step 3: Flows - Mapping Handler
  • Step 4: Integration Pipes
  • Step 5: Mapping Configuration

Was this helpful?

  1. TECHNICAL GUIDE

API and Mapping

While creating APIs in the API Manager, sample request and response are provided. The keys entered in this sample are reflected in the Source and Destination sections in the Mapping configuration page

PreviousSupported TimezonesNextCreate a new Integration Pipe

Last updated 5 years ago

Was this helpful?

Step 1: API Manager

When an API is created in the API manager, a for the API to be associated with. Also, are given while creating an API.

For more information, click

Now let us see how this API gets linked with the Mapping node

Step 2: Flows - API Call Handler

More than one API Call can be added in a Flow.

Step 3: Flows - Mapping Handler

The Mapping Handler is added to link data from a source API to a destination API.

When a Mapping Handler is added to the Flow, you will be choosing two API's (a source and a destination) to map. Note that, only API calls made within the Flow will be available for the user to select from.

Sample Request JSON

{
 "company_id": "string",
 "customer_id": 0,
 "idAlreadyExists": true,
 "id": "string",
 "first_name": "string",
 "last_name": "string",
 "title": "string",
 "direct_phone": "string",
 "email_address": "string",
 "isUpdate": true
}

Sample Response JSON

{
 "order_no": 225333,
 "shipping_cost": 30.00,
 "status": “paid”,
 "tax": 0,
 "payment_desc": "",
 "shipping_method": "fa",
 "order_date": "2019-10-21T04:13:37.541Z",
 "expiration_date": "2019-10-21T04:13:37.541Z",
 "ship2_name": "Alice",
 "ship2_city": "San Francisco",
 "ship_to_phone": "1234567890",
 "ship2_state": "California",
 "ship2_add1": "",
 "ship2_zip": "94016",
 "name": "Alice",
 "ship2_email_address": "alice@example.com",
 "mail_address1": "Jarvis St.",
 "mail_city": "San Francisco",
 "central_phone_number": "123456790",
 "email_address": "alice@example.com",
 "cancel_flag": false,
 "orderLines": [
 {
 "inv_mast_uid": 2,
 "item_desc": "Plate Set 1",
 "item_id": "QTR12",
 "unit_price": 12.24,
 "extended_price": 0,
 "qty_ordered": 1
 }
 ]
}

Step 4: Integration Pipes

While adding a new Pipe, you are required to choose System Credentials. Credentials are directly related to a system.

Depending on the Credentials (System) selected, the Flows (with API calls to those systems - Step 2) will be populated in the drop-down list.

Depending on the Flow selected, the Mapping nodes will be displayed (only if Mapping handler is added in the Flow - Step 2)

If no Mapping Handler is added in the Flow, Mapping node will not be displayed

Step 5: Mapping Configuration

Click on Configure. The mapping Configuration window will open.

The API Call Handler is added to the Flow to make an API call to a system. Depending on the system chosen, you can select an associated API from the drop down list. Any newly added API from will also be available in the list.

The Source API fields are populated from its sample response and Destination API fields are populated from its sample request provided in the API Manager page (From ).

Selecting System while adding a new API in API Manager
Mapping page showing Source and Destination APIs
Choosing APIs in the Mapping Handler
Adding a New Pipe
Mapping card after Flow is chosen
Source and Destination APIs in Mapping
system is chosen
sample request and response data
here.
here
Step 1