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
  • Add/Edit API
  • For Mapping: Request and Response
  • Other Details
  • Create as Private API
  • Test API

Was this helpful?

  1. PROJECT MANAGER
  2. Systems

API Manager

The DCKAP Integrator API Manager provides a user-friendly template to add, edit, manage and store any number of system APIs. The APIs that are added here are later used in Flows and Mapping.

PreviousCredentialsNextAPI Components

Last updated 10 months ago

Was this helpful?

Add/Edit API

To manage a new API, click on "Add New" on the API manager page. A new window will open and this is where you will define parameters and other details for your API.

For a private system, APIs can be added only when it has at least one credential.

DCKAP Integrator API Manager is only intended to manage APIs. The API is expected to be available in the respective systems. Adding an API here will not create the API in the respective system.

Provide the values for the below fields.

  1. Name: Provide a suitable name for your API. Example: Magento2 Update Customers, P21 Get Customer Info, etc.

  2. Status: This is a toggle ON/OFF button that allows you to enable/disable an API

  3. Click Save API button to save this API.

Use the Save All API button to save multiple added/modified APIs at once

For Mapping: Request and Response

The Request and Response sections contain sample JSON data. The keys given in this JSON sample are displayed as fields in the Mapping area Source and Destination sections to enable mapping.

The sample request and response fields are optional (but recommended) in the API Manager. If no data is entered here, then the Source and Destination fields will be empty on the Mapping configuration page.

Other Details

Skip Authentication

Ability to skip the parent system authentication. Applicable only to systems using the following protocols - OAuth1, OAuth2, NTLM, Amazon-LWA.

Override Timeout

This is a toggle ON/OFF button that lets you choose between custom/default "maximum allowed time" values, before which a Timeout error is thrown. Users can enter only 4-digit numeric values in the Connect and Read fields.

  • Override Timeout ON: Once the Override Timeout is set to ON, two fields- Connect and Read- are displayed. You may set a time (in seconds) in both these fields.

    • "Connect" refers to the maximum allowed time for DCKAP Integrator to establish communication with the system to which the API call is made.

    • "Read" refers to the maximum allowed time for the system to respond back to DCKAP Integrator.

  • Override Timeout OFF: Setting the Override Timeout to OFF, will consider default values for "Connect" and "Read".

  • The default value for Read = 240 seconds. The default value for Connect = 30 seconds

Description

Provide the description/notes for the API

Create as Private API

This is applicable to Public APIs only. Using this option, any public API can be duplicated and created as a private API to make necessary modifications.

Test API

Navigate below to learn about API testing from Integrator

Provide request , , , and for the API

Provide to use in the mapping.

Provide section (Optional)

API can be tested from here if needed. Navigate to

For protocols like FTP and SFTP, APIs cannot be added. Instead, it will be used with the help of flow handlers like , , & .

Test API
Test API
Learn more.
request and response
other details
Add/Edit API
Create as Private API
Test API
method
URL
headers
params
body
FTP Reader
FTP Writer
SFTP Reader
SFTP Writer