Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 4.5 KB

README.md

File metadata and controls

87 lines (59 loc) · 4.5 KB

K2 Dropbox Connector

This connector for K2 Cloud integrates with DropBox. It allows you to download and upload files, copy, move, and delete files, manage folders, manage tags, and search for files and folders.

License: MIT

Features

  • Download and upload files
  • Search for files and folders
  • Update and delete files and folders
  • Manage tags (metadata) on files and folders

Note that while the .js or .jssp file can be modified, this is minified/bundled JavaScript and it is not recommended that you modify the files directly. Please log tickets using the K2 Partner and Customer Portal and log any feature requests on our Ideas portal.

Getting the Dropbox Connector to work in your K2 environment

Before you see SmartObjects and run methods on them, you must do the following:

  • Create a Dropbox App using Dropbox's My apps page
  • Create a secret for your app and copy the secret and the ID of the app for configuring an OAuth resource in K2
  • Create an OAuth Resource Type in K2 Management
  • Create an OAuth Resource in K2 Management based on the new resource type
  • Create a Google Drive service type with the bundled .js or .jssp file
  • Create a service instance for the type using the OAuth resource you created

Creating the Dropbox App

For information about creating an app in Dropbox see Dropbox's OAuth guide

Creating the OAuth Resource Type in K2

Next, create the OAuth resource type in K2. Follow these steps:

  1. Browse to K2 Management and expand the Authentication node
  2. Expand the OAuth node
  3. Click Resource Types and then click New and give it a name
  4. Add the following parameters to your resource type:
  • Resource type parameters
    • redirect_uri: for Authorization Request & Token Request set it to true
    • client_id: for Authorization Request & Token Request set it to true
    • response_type: for Authorization Request & Token Request set it to true
    • grant_type: for Token Request set it to true, Token Default Value = authorization_code
    • client_secret: for Token Request set it to true
    • expires_in: for all requests set it to false (you use this as a token replacement value because Dropbox does not support refresh tokens)
  1. Save all of your changes

Once you've created your OAuth resource type, you can create your OAuth Resource.

Creating the OAuth Resource in K2

Once you have your resource type created, create your resource that you'll use to configure your service instance. Follow these steps:

  1. Browse to K2 Management and expand the Authentication node
  2. Expand the OAuth node
  3. Click Resources and then click New
  4. Give your resource a name, select Dropbox as the Resource Type (or whatever you called it above), and then paste the authorization endpoint (https://www.dropbox.com/oauth2/authorize) into the Authorization Endpoint field, and the token endpoint (https://api.dropboxapi.com/oauth2/token) into the Token Endpoint
  5. Add the following parameters to your resource:
  • Resource parameters
    • redirect_uri: your K2 Cloud redirect URI, such as https://kyg4qhn.onk2qa.com/identity/token/oauth/2
    • client_id: the client ID of your Google app for all three request values
    • response_type: Authorization Value = code
    • grant_type: Token Value = authorization_code, Refresh Value = refresh_token
    • client_secret: Token Value & Refresh Value = your client secret
  1. Add the following Token Replacement Value + expires_in: 259200
  2. Save the resource and confirm that it's similar to the following figure

Example OAuth Resource for Dropbox

Once you've created your OAuth resource, you can now use it to configure a service instance, but you must first create your service type.

Creating your Dropbox Connector Service Type

Download the index.js or index.jssp from the repo.

Once you have your index.jssp file for the Dropbox Connector, create your service type using the example form from the Help topic or one you've built yourself.

When your service type is created, register a service instance using the OAuth resource you created, and generate SmartObjects.

License

MIT, found in the LICENSE file.

www.k2.com