DryvIQ Platform SDK Development
Read an overview about the DryvIQ Platform SDK.
Table of Contents
Contact Us
Our SDK repository is not publicly available. Please contact us for more information.
The SDK references SkySync. This is expected.
Platform Extensions Overview
The DryvIQ Platform allows users to connect to on-premise and cloud storage platforms and orchestrate the content contained within those platforms. Out of the box, this includes migration and synchronization of content between platforms and any related metadata and permissions. However, the platform was never intended to solve every problem or connect to every storage platform out of the box. As such, the platform allows customers and extension developers to extend it in several ways to suit their needs better. Examples include:
- Adding a custom connector to allow DryvIQ to connect to on-premise or cloud storage platforms that are not provided out of the box.
- Adding a custom transfer extension that transforms content (i.e., converting Word documents to PDF) during an ongoing migration job.
- Integrating a 3rd party document classification engine that enhances custom metadata (i.e., extract invoice numbers and customer names from documents) attached to documents during an ongoing migration job.
- Adding a custom REST service that exposes DryvIQ data rolled up differently or data generated from a custom transfer extension.
Installation and Configuration
SDK Prerequisites
- .Net Core SDK (currently using the latest 3.0 release)
- .Net IDE of choice (DryvIQ recommends JetBrains Rider or VS Code)
Getting access to the DryvIQ SDK packages
- Create an account on MyGet (https://www.myget.org/Account/Login).
- Obtain an API key from our private skysync-vnext NuGet repository (https://www.myget.org/feed/Details/skysync-vnext, under the heading API key). If you do not have access to the skysync-vnext repository, please send an email to contact us to request access.
- Edit %APPDATA%\NuGet\Nuget.config. Add the following within the <configuration> block, replacing %MYGET_AUTH_TOKEN% with the API key.
<packageSources>
<add key="SkySyncSdk" value="https://www.myget.org/F/skysync-vnext/auth/%MYGET_AUTH_TOKEN%/api/v3/index.json" />
</packageSources>
You may need to add only <add key="..." value="..." /> if a <packageSources> block is already in the <configuration> block.
Getting access to the DryvIQ SDK samples
Fork the skysync-sdk repo and clone it locally (e.g., git clone git@github.com:youraccount/skysync-sdk.git).
https://github.com/portalarchitects/skysync-sdk
This repository is not publicly available. Please contact us for more information.
All of the samples contained within should include instructions on building and testing, but the basic flow is to run dotnet build or dotnet test from a terminal window.