-
Notifications
You must be signed in to change notification settings - Fork 4
docs: add API connectivity documentation and index entry for data exchange #252
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0879703
docs: add API connectivity documentation and index entry for data exc…
mickeytp 7e9f050
docs(sidebars): add Data Exchange category to sidebar
mickeytp 1b04cd5
Implement code changes to enhance functionality and improve performance
mickeytp 8fb6696
docs(connect-api): update link to tapio Auth API documentation
mickeytp 3586763
fix(docs): ensure newline at end of file in connect-api documentation
mickeytp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). | ||
|  | ||
|
|
||
| - Create an AuthorizationKey (one-time copy). | ||
|  | ||
|
|
||
| - 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. | ||
|
|
||
|  | ||
|
|
||
| ## 💻 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Data Exchange | ||
|
|
||
| - [How to connect to API](./connect-api.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.