OData API
From Syntaro Help
Introduction
As of Syntaro release 1811 we provide an OData API Interface for customers and partners. Trough OData information about your Syntaro environment and usage can be accessed.
How to get your API-Key
Your API-Key can be accessed through your Syntaro tenant. Go to the Marketplace then select the menu point "API Key". Here your API-Key will be displayed. You can now copy the API-Key to your clipboard. If you are a Syntaro partner please contact the baseVISION Support Team under support@basevision.ch to receive your API-Key.
Entities
| Entity | Description | Link to Access | Accessible for | ||
|---|---|---|---|---|---|
| Customers | Partners | Syntaro | |||
| Tenant | General information about your tenant or tenants that have entered you as Partner of Record for at least one Syntaro module. The data includes company name, billing address and information. | https://portal.syntaro.com/partnerapi/odata/Your-API-KEY/Tenant | Yes | Yes | Yes |
| Partner | Information stored about Partners is only available throught the OData API. | For internal use only. | No | No | Yes |
| Subscription | Information regarding your active subscriptions are shown. For partners, every subscription where you are entered as PoR (partner of record) will be displayed. | https://portal.syntaro.com/partnerapi/odata/Your-API-KEY/Subscription | Yes | Yes | Yes |
| Kickback | Partners can see Kickback information for subscriptions where they were entered as PoR. | https://portal.syntaro.com/partnerapi/odata/Your-API-KEY/Kickback | No | Yes | Yes |
| SyntaroPackage | Contains the all the Syntaro Packages of your tenant. The data includes deployment statistics and Syntaro package information. When your company is entered as PoR the packages of your customer tenants are displayed as well. | https://portal.syntaro.com/partnerapi/odata/Your-API-KEY/SyntaroPackage | Yes | Yes | Yes |
| Device | All devices of your Application Management tenant are listed in this entity. As soon as you are a PoR for a tenant you will see the devices of such tenants as well. | https://portal.syntaro.com/partnerapi/odata/Your-API-KEY/Device | Yes | Yes | Yes |
| Inventory | Detailed deployment statistics of applications to the devices of your tenant. The values contain information whether an application has been installed on a device or not. This entity contains all the Apps from external providers within Syntaro as well (currently RuckZuck). | https://portal.syntaro.com/partnerapi/odata/Your-API-KEY/Inventory | Yes | Yes | Yes |
| DeploymentRing | In this Entity all configured Deplyoment Rings of your Syntaro tenant are displayed. You will also see the Deployment Rings of those tenants where you are Partner of Record. | https://portal.syntaro.com/partnerapi/odata/Your-API-KEY/DeploymentRing | Yes | Yes | Yes |
Access Data with PowerBI oder Excel
Below you'll find short introductory documentations on how to access your OData feed with PowerBI or Excel. For further information or if you want to know how to manage the data inside such applications, please consult the product documentation of the data consuming applications.
PowerBI
| Install PowerBI Desktop if not already present on your computer. Then start PowerBI Desktop. | |
| Once PowerBI has opened, click on "Get data". | |
| In the menu select "Others" and then choose the "OData Feed" and press on "Connect". | |
| Customize the following URL with your API-Key: https://portal.syntaro.com/partnerapi/odata/Your-API-KEY
| |
| Select all the entities you would like to load. (You can see the Data already in the preview Pane).
| |
| Wait for the loading process to finish. Once it has been completed you're able to display and consume the data of the OData feed in PowerBI. |
Excel
| Open Excel. | |
| Go to the ribbon "Data", then click on "Get Data". Select the menu point "From Other Sources" and then finally choose "From OData Feed". | |
| Customize the following URL with your API-key: https://portal.syntaro.com/partnerapi/odata/Your-API-KEY
| |
| Select all the entities you would like to load. (You can see the Data already in the preview Pane).
| |
| Wait for the loading process to finish. Once it has been completed you're able to display and consume your Syntaro data in Excel. |
