API - Create Data

In this article, we'll guide you through making an API call to "Create Data" on in Breeze using two methods: curl and JavaScript's fetch .

Overview

The Create Data API allows you to send and record data points in your Breeze account. Below you'll find step-by-step instructions for both methods.

Use Cases

This endpoint can be used for many different applications, including these examples:

Data Definitions

Below is a table defining all the parameters you can use with this API call, their necessity, where to find them, and an example value:

Using curl

The curl command is a tool available in most UNIX systems and can be used to make HTTP requests directly from your terminal or application

To use the Create Data API with curl , follow these steps:

1. Open your terminal or command prompt.
2. Copy and paste the following command:

bashCopy codecurl --location 'https://mybreeze.io/api/1.1/wf/create-data' \
--header 'Authorization: Bearer YOUR_AUTH_TOKEN' \
--form 'API_key=YOUR_API_KEY' \
--form 'organization_ID=YOUR_ORG_ID' \
--form 'place_ID=YOUR_PLACE_ID' \
--form 'source_ID=YOUR_SOURCE_ID' \
--form 'start_date="YYYY/MM/DD"' \
--form 'end_date="YYYY/MM/DD"' \
--form 'usage_quantity="QUANTITY"' \
--form 'usage_unit="UNIT"' \
--form 'notes="YOUR_NOTES"'

3. Replace placeholders
4. Press Enter to execute the command. If successful, you will see the response from our server.

Using JavaScript's fetch

For those who prefer or need to use JavaScript, you can utilize the fetch method.

Follow the steps below:

1. Create a new JavaScript file or open your existing project.
2. Copy and paste the code snippet below:

javascriptCopy codevar myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer YOUR_AUTH_TOKEN");
var formdata = new FormData();
formdata.append("API_key", "YOUR_API_KEY");
formdata.append("organization_ID", "YOUR_ORG_ID");
formdata.append("place_ID", "YOUR_PLACE_ID");
formdata.append("source_ID", "YOUR_SOURCE_ID");
formdata.append("start_date", "YYYY/MM/DD");
formdata.append("end_date", "YYYY/MM/DD");
formdata.append("usage_quantity", "QUANTITY");
formdata.append("usage_unit", "UNIT");
formdata.append("notes", "YOUR_NOTES");
var requestOptions = {
 method: 'POST',  headers: myHeaders,  body: formdata,  redirect: 'follow' };
fetch("https://mybreeze.io/api/1.1/wf/create-data", requestOptions)
 .then(response => response.text())  .then(result => console.log(result))  .catch(error => console.log('error', error)); 

3. Replace placeholders
4. Run your JavaScript file. The results will be displayed in the console.

Troubleshooting

1. Authentication Errors: Ensure that the Authorization token and API_key are correctly placed.
2. Data Formatting: Ensure that all data being sent follows the required format. For example, dates should follow the "YYYY/MM/DD" format.
3. If you encounter any other issues or have further questions, please contact our support team at support@mybreeze.io

We hope this guide helps you effectively utilize our Create Data API. Happy coding!