API Reference | ReDoc

Lynks

Product Info

The Lynks API provides businesses an ability to install and manage Lynks without building integrations from scratch.

A Lynk is a pre-built integration connector that links a specific platform or service (for example, a Shopify store) to the Lynkup system, and helps gather & share information from or to the external systems.

Business Values

  • Faster Onboarding: - Lynks API provides out-of-the-box integrations, so integration is largely a matter of configuration (providing details and basic settings). This dramatically reduces integration time and complexity.

  • Eliminate Custom Integration Costs: - Businesses can connect to new platforms or services with an API call rather than lengthy development projects.

  • Faster Time to Market: - Lynks allow for quick and repeatable integration, and businesses can scale their solutions without lengthy development cycles, achieving a faster time-to-market for new offerings.

  • Automates Data Exchange and Centralizes Connectivity: - Lynks unifies data and processes across all connections into a single platform, giving businesses centralized visibility and insights.

  • Quicker Lynk Introduction: - The Lynks catalog is extensible, so new Lynks can be added to support additional platforms quickly.

How does it work once I am setup as a user?

Once you’re set up, use the Install API to add any supported Lynk into Lynkup.

Enabling a Lynk kicks off its automated workflows. When you need to pause a Lynk (for maintenance or migration), the Disable API halts its data exchanges while preserving your configuration.

By leveraging these APIs, you maintain seamless connectivity and control over all your integrated apps with minimal manual effort.

FAQs

  • Can Lynks API scale to support multiple platforms or services?

    Absolutely. Lynks are designed to be reusable and modular; businesses can connect multiple platforms and even multiple instances of the same platform to suit their business needs.

  • Will installing a Lynk affect my existing integrations?

    No. Each Lynk operates independently. Installing a new Lynk will not interfere with your existing Lynks.

  • What resources are required to maintain these integrations?

    Lynkup platform manages Lynks; connectors receive updates centrally on the platform. Businesses do not need dedicated development resources to sustain them, freeing IT to focus on strategic initiatives.

  • What happens to existing data when I disable a Lynk?

    Disabling a Lynk stops future data exchanges, but all historical data (orders, logs, configuration) remains intact in Lynkup, till the specified retention period.

Install a Lynk

Creates a new connection between a selected Lynk and the Lynkup platform. Using the Lynk name and initial configuration, it registers the connection, manages any necessary onboarding (OAuth or credential checks). Once complete, the Lynk is ready for use in automated workflows.

SecurityOAuth2ClientCredentials
Request
path Parameters
version
required
string
Default: "v1"

version

Value: "v1"
Request Body schema: application/json
lynkKey
required
string <= 100 characters

key used to identify the lynk in our system

lynkDisplayName
string <= 100 characters

Display name of the lynk

configuration
object

Configuration object specific to the lynk

redirectUri
string <= 10000 characters

URL to which a user is redirected after performing a specific action

tags
Array of strings [ 0 .. 20 ] items

Additional information related to the lynk.

Responses
200

Request was successful

400

Bad Request

401

Unauthorized

422

Processing failed as request contains invalid data

500

Internal server error

post/lynk/{version}/applications/install
Request samples
application/json
{
  • "lynkKey": "shopify",
  • "lynkDisplayName": "Shopify Custom App",
  • "configuration": {
    },
  • "redirectUri": "http://example.com/list",
  • "tags": [
    ]
}
Response samples
application/json
{}

Enable/Disable a Lynk

Switches a previously installed Lynk into an active/inactive state, triggering its automated workflows (order imports, shipping requests, etc) specific to the action.

SecurityOAuth2ClientCredentials
Request
path Parameters
version
required
string
Default: "v1"

version

Value: "v1"
connected_lynk_id
required
string^[a-fA-F0-9]{24}$

The unique lynk Id generated by the system after installing a lynk

Example: 60b8d6c9e4b0f5d3a1a6e500
action_type
required
string

action to be performed on the specified lynk

Enum: "enable" "disable"
Responses
200

Request was successful

400

Bad Request

401

Unauthorized

422

Processing failed as request contains invalid data

500

Internal server error

post/lynk/{version}/applications/{connected_lynk_id}/{action_type}
Request samples
Response samples
application/json
{
  • "message": "connectedLynkId is a required field. The field is missing.",
  • "type": "INVALID_DATA",
  • "errors": [
    ]
}