Integration Protocol Documentation - Third Party -
Web
Introduction
Welcome to the documentation for our third-party API. This API is designed to facilitate integration and communication between systems, enabling efficient and centralized management of various types of information. With our API, users can perform key operations such as creating, editing, deleting, and querying data. The main functionalities include:
Work Orders: Comprehensive management of work orders, including their creation, updating, and deletion.
Hierarchical Structure: Detailed management of the hierarchy of producers, establishments, and lots.
Campaigns and Crops: Administration and tracking of agricultural campaigns and specific crops.
Master Data: Specific queries to master data to obtain precise and up-to-date information.
Scoutings: Access to monitoring data for detailed tracking of crop status.
Our API is implemented using the REST standard, ensuring simple and efficient communication. Data is exchanged in JSON format, ensuring easy integration with various systems and platforms.
The following sections provide details on the available endpoints, message format, and usage examples to help you make the most of our API's capabilities.
First Steps
In order to access the WorkOrders consumer service, you must first log in.
Test url:
https://api.qa.sima.ag
How to get the user API-KEY (login)?
You must use the next endpoint to obtain the access_token.
Login uri:
/api/v2/login
Method:
POST
Header:
Body:
Response example:
If we get an Http 200 response, we recommend saving the access_token obtained for future inquiries.
Necessary endpoints to integrate as a third party
ActiveIngredients Active Ingredients Endpoint
Application Order Labour Types: Application Order Labour Types Endpoint
Applicators: Applicators endpoints (v3)
Campaigns: Campaigns endpoint (v3)
Companies: Companies endpoint
Components: Components EndPoint
Cultivations: Cultivation endpoints (v3)
Establishments: Establishment endpoints (v3)
Farmers Farmers EndPoint
Formulateds: Formulateds endpoint (v3)
Formulation Types: Formulation Types endpoint
Formulate Use: FormulatedUse endpoint
Machines: Machines endpoints (v3)
Master Campaigns: Master Campaigns endpoints
Planting Times: Planting Times endpoint
Plots: https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2691006466
Units: https://sima.atlassian.net/wiki/spaces/WOIPD/pages/3262414849
Voucher Labour Types: https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2105704498
Warehouse: https://sima.atlassian.net/wiki/spaces/WOIPD/pages/3316023297
Work order endpoints
https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2106032164
Format
https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2105311275
Description of protocol attributes
https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2106261521
Class diagram
Link to class diagram: https://drive.google.com/file/d/1UfsRqjM7wborKcKFlnAaCgVVkrbdwXyb/view?usp=sharing
Scouting EndPoints
Adversity Kinds https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2777841665
Adversity Categories https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2775646211
Adversity https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2798288897
Scouting https://sima.atlassian.net/wiki/spaces/WOIPD/pages/2800320513
Postman Collection
Api Access (Demo account)
user: demo@sima.ag
pass: demo_sima
Web Access (Demo account)
user Spanish: demo-web@sima.ag
user Portuguese: demo-web-pt@sima.ag
pass: 45V0yxDejlamwWwG