BeCrop API

What is the BeCrop API, and how do you use it?

API stands for Application Programming Interface. In the context of APIs, the word Application refers to any software with a distinct function. Interface can be thought of as a contract of service between two applications.

Through the API, you will be able to have your results in other environments where you can manage your information to exploit the results along with other decision variables and save time in manually integrating all your data that you already have in other environments.

Who is BeCrop API appropriate for?

BeCrop API is a way to connect your data to another platform, so any BeCrop customer will be able to use this service. However, we recommend that you have some technical knowledge or an IT specialist to be able to carry out the connections properly. 

It is typically used by distributors with several clients who must make recommendations based on several layers of information, one of them being the biological information of the soil.

What can I use BeCrop API for?

As mentioned above, the BeCrop API is designed to connect the information from the analyses performed on your platform so that you can integrate all the information in one place. 

The layers of information you can connect with another application are: 

1. Services
2. List of clients and their data
3. List of purchase orders
4. List of plots/parcels
5. List of samples
6. BeCrop Test information
7. BeCrop Rate Information
8. BeCrop Trials Information
9. Abundance and reporting information
10. Information on Bioactivity Reports 

and much more.

How can I use BeCrop API? 

Once you have contracted one of the BeCrop services, you will get some results, all the information you add to BeCrop Portal can be extracted through the API. 

Connecting BeCrop API

The connection process is relatively simple, starting with a testing period and, once the quality of the connections has been verified, working directly on the platform. 

1. Becoming an API client

A TOKEN is needed to use the BMK API, and it should be created from the portal COMPANY PROFILE view. To reach this view, click the PROFILE DROPDOWN, and the ORGANISATION option inside the portal.

You can reach this view using the following link: https://portal.becrop.com/biomemakers-client-profile

If your client were upgraded to be an API client, you would see the following action panel, with the plus icon. If you do not find this panel, contact us to activate it for your client.

Click the “PLUS” button, and the following dialog model will appear. Select the scopes corresponding to the token (see the first section of this document to understand a scope), give it a name, and create it. Please copy your token to a safe place on your repositories because it will not be displayed anymore.

2. Sandbox environment

In order to allow third parties to develop and check the integration of their systems against our API without having harmful or negative consequences, we have deployed a complete testing environment called Sandbox. In this environment, we find a simulated database where the information isn't real but accurately represents a comprehensive range of production scenarios, along with the key systems found in the production environment:

1. API Test (a.k.a. api-sandbox)
2. BeCrop Portal clone (a.k.a. sandbox portal)
3. Interactive API Documentation

In this first part, you will test several variables such as customers, orders, samples, and results using a unique token that you will have created following the previous steps.

Now you will be able to connect all the variables or endpoints. For this, you can find a complete description of the rest of the API endpoints associated with different entities and different functionalities in the OpenAPI live description: 

https://api-doc-sandbox.biomemakers.com/#get-/

🔖 Articles in this category

• BeCrop Test
• BeCrop Trials
• BeCrop Rate
• BeCrop API