Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/data-exchange/assets/choose-addon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/data-exchange/assets/create-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/data-exchange/assets/dataflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions docs/data-exchange/connect-api.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/data-exchange/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Data Exchange

- [How to connect to API](./connect-api.md)
11 changes: 11 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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'
],
},
]
};
Loading