diff --git a/docs/data-exchange/assets/choose-addon.png b/docs/data-exchange/assets/choose-addon.png new file mode 100644 index 0000000..3a5547f Binary files /dev/null and b/docs/data-exchange/assets/choose-addon.png differ diff --git a/docs/data-exchange/assets/create-key.png b/docs/data-exchange/assets/create-key.png new file mode 100644 index 0000000..eeac93c Binary files /dev/null and b/docs/data-exchange/assets/create-key.png differ diff --git a/docs/data-exchange/assets/dataflow.png b/docs/data-exchange/assets/dataflow.png new file mode 100644 index 0000000..bed1863 Binary files /dev/null and b/docs/data-exchange/assets/dataflow.png differ diff --git a/docs/data-exchange/connect-api.md b/docs/data-exchange/connect-api.md new file mode 100644 index 0000000..b0fd444 --- /dev/null +++ b/docs/data-exchange/connect-api.md @@ -0,0 +1,54 @@ +# API Connectivity + +## Overview +The tapio allows integration partners to connect ERP systems, Tool Managers, and measurement systems with tapio services. +Partners can securely access Tadamo and MaintenanceService (MS) APIs through **AuthorizationKeys** generated from add-ons. + +### Supported Add-ons +- **ERP Add-on (SharpeningUI)** +- **Measurement Add-on (SharpeningUI)** +- **ToolManagerOffice Add-on (Twinio)** + +Each add-on can generate its own **AuthorizationKey**, which serves as the credential for API access. + +## 🔑 Authentication + +### AuthorizationKey + +An **AuthorizationKey** is issued via the add-on settings in the tapio portal. +- The key is generated by the customer and shared with the integration partner (e.g., ERP, Measurement, or Tool Manager system). +- The key is **valid until explicitly revoked**. + +### Scope + +Keys are scoped to the customer subscription and application. + +## ⚙️ Add-on Configuration + +- Go to the tapio portal. + +- Navigate to the relevant Add-on (ERP, Measurement, ToolManagerOffice). +![Choose Add-on](./assets/choose-addon.png) + +- Create an AuthorizationKey (one-time copy). +![Create key](./assets/create-key.png) + +- Paste the key into your integration system configuration. + +## 🔄 Data Flow + +- ERP / Measurement / ToolManager → calls TADAMO or MaintenanceService with AuthorizationKey. + +- Tadamo/MS validate AuthorizationKey with subscriptionId and applicationId. + +- SharpeningUI and Twinio act as the customer-facing add-ons where keys are managed. + +![Data Flow](./assets/dataflow.png) + +## 💻 Code Samples + +For practical implementation examples of how to configure authentication for the TadamoApiClient and MaintenanceServiceApiClient, see the code samples and documentation at: + +**[tapio Auth API Documentation](https://tapioone.github.io/tapio-samples/)** + +This resource provides detailed examples and best practices for implementing authentication configuration for both API clients. diff --git a/docs/data-exchange/index.md b/docs/data-exchange/index.md new file mode 100644 index 0000000..50d8db9 --- /dev/null +++ b/docs/data-exchange/index.md @@ -0,0 +1,3 @@ +# Data Exchange + +- [How to connect to API](./connect-api.md) diff --git a/sidebars.js b/sidebars.js index efea911..8c5b6b5 100644 --- a/sidebars.js +++ b/sidebars.js @@ -121,5 +121,16 @@ module.exports = { 'products/partner-connector' ], }, + { + type: 'category', + label: 'Data Exchange', + link: { + type: 'doc', + id: 'data-exchange/index' + }, + items: [ + 'data-exchange/connect-api' + ], + }, ] };