---
title: "Secure API's"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28381040/Secure%20API's"
format: markdown
---
# Overview 

With a wide range of applications used by our customers out in the workplace, ranging from customer-written applications to off-the-shelf tools, the Framework Secure <span style="color: #222222">Application Programming Interfaces (</span>API) are designed to meet most of your current needs. 

> ℹ️ Additional API’s can be added by usual business process with Sterland through a combination of R&D and paid development

With regards to the business logic and versioning of the Frameworks integration platform, our secure API will use the core Frameworks functions, and all application rules apply to these API's. Any errors returned by the API will be the same as those returned by the Frameworks user interface (UI). Also, fields that are exposed in the UI will be the same as those exposed in the API. Version will be maintained for backwards compatibility. 

# API Types

There are 2 API types to meet different integration needs:

### External Application calling Frameworks API’s to:

- Search for and retrieve data from Frameworks
- Create and update data in Frameworks

**Example:**

![image](media://cb89dd76-0136-441b-875a-a9a2a2ab4039)

### Frameworks call an External application API when:

- Master file data changes in Frameworks (e.g. customer, supplier)
- A Frameworks transaction event occurs (e.g. order confirmed)

**Example:**

![image](media://7a06f50a-d844-498a-865c-708f10d2fba3)

# Additional Information

> ✅ Refer to [API Availability](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28391092) for more information.
> ✅ 
> ✅ Refer to [Frameworks Web Hooks - Setup and Configuration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28391110) for more information. 
> ✅ 
> ✅ Refer to the [postman API documentation](https://documenter.getpostman.com/view/873359/Uyxkijs6)<span style="color: #222222"> for more </span><span style="color: #222222">**technical**</span><span style="color: #222222"> information relating to the API's</span>