1. LeafLink’s API

Follow

LeafLink’s API and WebHook integrations allow your developers to connect information from LeafLink to your third-party software. It’s off by default, but you can request API access turned on for your account. Reach out to your account rep or contact us at support@leaflink.com to get the conversation started.

What is an API & WebHook?

Both are ways to transfer information from our software to yours, here’s an overview of the differences:

API

An API is an integration where information is transferred from one piece of software by another via specific requests.

WebHook

A WebHook is an integration where information is transferred from one piece of software by another automatically.

Using API & WebHook integrations

In order to take advantage of LeafLink’s API or WebHook integrations, the settings will need to be enabled for your account. Reach out to our team here to get started adding these integrations to your account.

Once your account is setup, you’ll find Developer Settings under Settings in the LeafLink navigation panel.

To Generate an API Key

After navigating to Developer Settings, follow these steps:

  1. Click the API tab near the top of the screen.
  2. Enter the password for your login and click Generate Key.
  3. Copy the resulting Key to use in your API integration.

WebHook

Currently, LeafLink provides one WebHook for Orders. After navigating to Developer Settings, follow these steps:

  1. Click the WebHook tab near the top of the screen.
  2. Set up the Receiving end of the WebHook for your software.

When a new Order is placed, LeafLink's WebHook is triggered and sends the data to your server. Data is sent in a standard format (JSON) ensuring your system is able to process it.

Adding a New WebHook

After navigating to Developer Settings, follow these steps:

  1. Choose a Name for your WebHook.
  2. Enter the URL where you have built an integration that can consume the WebHook.
  3. Select the Type of WebHook.
  4. Click Add WebHook.

Accessing API & WebHook Documentation

After navigating to Developer Settings, follow these steps:

  1. Click the API tab near the top of the screen.
  2. Click the Interactive Docs button.
  3. Click Show/Hide on the API row. 

 

0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.