API Key

Updated 1 month ago by Karan

Introduction

The API key is used in running Byteline flows through Webhooks. API Key can be either in the query parameter or in the headers. The API key is a token that gets passed by the application that calls the API to identify its user. It tracks and controls how API is being used, to prevent abuse of the API or malicious use.

How to Generate API Key

Step -1: Click on the profile icon on the top-right corner of the Byteline flow designer console.

Step -2: Select the account option from the profile drop-down.

Step -3: Click on the copy button to get the API key from the API key textbox to run Byteline flows through form submissions or APIs.

You can click on the show/hide button to show/hide your API key.

Click on the blue-colored regenerate key to regenerate the API key.

How to pass apiKey

You must use an URL query string parameter to pass the API key. The name of the parameter is apiKey. Query parameters are a defined set of parameters attached to the end of a URL. They are extensions of the URL that are used to help define specific content or actions based on the data by a query parameter. Below is an example URL.

URL

https://api.byteline.io/flow/AUfCtaPgFNRART/run?apiKey=RXGqdGhtYTNFABwTSRNJ

Feel free to connect us for any doubt.


How did we do?