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.
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.
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.
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.
Request Body schema: application/json
Request was successful
Bad Request
Unauthorized
Processing failed as request contains invalid data
Internal server error
- Payload
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
{- "lynkKey": "shopify",
- "lynkDisplayName": "Shopify Custom App",
- "configuration": {
- "clientId": "1234",
- "clientSecret": "XXXX"
}, - "tags": [
- "businessId"
]
}- 200
- 400
- 401
- 422
- 500
{- "connectedLynkId": "6821a0ef47c2aa82a98e62db",
- "isRedirectionNeeded": true
}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.
path Parameters
Request was successful
Bad Request
Unauthorized
Processing failed as request contains invalid data
Internal server error
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
- 400
- 401
- 422
- 500
{- "message": "connectedLynkId is a required field. The field is missing.",
- "type": "INVALID_DATA",
- "errors": [
- {
- "type": "INVALID_DATA",
- "message": "connectedLynkId is a required field. The field is missing.",
- "parameter": null,
- "entityId": null,
- "entity": null
}
]
}