Skip to main content
Version: 1.0

We-Link API Documentation

Overview

Welcome to the We-Link API documentation! This specification provides a comprehensive guide to integrating with the We-Link API. The We-Link API offers developers the ability to automate tasks, retrieve data, and seamlessly connect with various We-Link services such as messaging, collaboration, and more.

In addition to detailed API descriptions, request/response formats, and authentication guidelines, we've made it easy for you to test the API right from this documentation. You can directly try out the available endpoints and interact with the API in real-time, ensuring that your integration process is as smooth as possible.

In this specification, you will find:

  • API Endpoints: A full list of available endpoints to access We-Link services, with descriptions of each.
  • Try It Yourself: An interactive feature that allows you to test API calls directly from the documentation page. This lets you see real-time responses and experiment with different parameters.
  • Request & Response Formats: Clear examples showing the structure of requests and responses.
  • Authentication: Instructions on authenticating your API requests securely using your API Key and API Secret.

The We-Link API is designed to be intuitive and flexible, making it easier for you to implement and enhance the capabilities of your applications. Explore the documentation, try out the API in the interactive environment, and feel free to reach out if you need further assistance.

Asynchronous API Requests

All We-Link API endpoints except /api/v1/get_response and the account management APIs are asynchronous. When user invokes an API endpoint, the operation begins asynchronously within the We-Link engine, and the response will contain a requestID instead of the final result.

How It Works:

  1. Initiate Request: When you make an API call, the We-Link engine begins processing the request asynchronously and returns a requestID.
  2. Webhook Notification: Once the asynchronous operation is completed, the result will be sent to the user's configured Webhook endpoint, providing the final outcome of the operation.
  3. Track Status: Users can also check the progress of their request at any time by calling the /api/v1/get_response endpoint, passing the requestID. This allows users to monitor the status until the operation is complete.

This asynchronous design allows for better performance and flexibility, as long-running operations will not block the user's workflow, and results are delivered directly via webhook once ready.

API Rate Limit

To protect your LinkedIn account and ensure its safety while interacting with the We-Link API, we enforce a rate limit of 30 requests per hour per account. This rate limit is designed to prevent abuse and ensure that your account stays secure by reducing the risk of excessive activity.

Key Points:

  • Limit: 30 requests per hour per account
  • Window: A 60-minutes rolling window
  • Exceeding the limit: Once the limit is reached, any additional requests will be denied until the next hour begins, and a 429 Too Many Requests error will be returned.

This rate limit helps safeguard your LinkedIn account by preventing overuse or unexpected behaviors that might flag your account for suspicious activity. We recommend monitoring your usage to stay within the limit and avoid interruptions. If the limit is exceeded, you will need to wait until the rate limit resets before making additional requests.

By adhering to this limit, you can ensure that your LinkedIn account remains secure while using the We-Link API.