Getting Started

Login to Syncplicity account

The Getting Started API documentation provides information to assist you with the development and management of your applications using the Syncplicity APIs.

To get started, you must have Syncplicity Enterprise Edition and developer sandbox accounts. This topic provides direction on how to obtain these accounts, as well as the terms of your new sandbox account.

Prerequisites

Prior to developing with Syncplicity APIs, the following knowledge and accounts are required:

Knowledge

• Understand Syncplicity features: If you are not familiar with the administrative and end-user functionalities of Syncplicity File Sync and Share service, visit the Syncplicity website and review the online documentation.
• Have experience with using REST APIs: Syncplicity APIs follow representational state transfer (REST) architectural style and supports XML or JSON for request and response. Use the embedded links throughout the API documentation to learn more about REST APIs and JSON.

Accounts

• Syncplicity Enterprise Edition account: To log in to the Syncplicity Developer portal, you must be a member of a Syncplicity Enterprise Edition account. This account allows you to utilize all of the actions that a Syncplicity administrator can perform. To learn more, visit this link. 
• Syncplicity developer sandbox account: Prior to using the developer portal, you must initially create your sandbox account, as follows:

1. Sign into the Syncplicity Developer Portal with your regular Syncplicity account.
2. Select My Profile and click Create sandbox. 
3. Enter a password. 
4. Log in to My Syncplicity  to ensure your account is valid and correctly provisioned.

NOTE:  If you use the client credentials OAuth 2.0 flow, you can use your developer sandbox account to create an application token for authenticating yourself before making API calls. 

Terms of your account

Your Syncplicity Enterprise Edition developer sandbox account comes with the following advantages and limitations:

Advantages

• It is a free, full-featured account with access to all APIs.
• It is provides the following configuration:
  • 3 year lease to enable development (to extend the lease, contact Syncplicity customer support)
  • 10 GB of content storage capacity
  • Up to 1,000 user seats

Limitations

• You cannot increase the maximum limit for user seats.
• You cannot increase the content storage capacity.

Create/register an application

From the Applications page of the Developer Portal you can:

• Register applications to obtain an application key and secret.
• Manage your development team.
• Monitor application usage metrics.

Before creating an application

Before you create an application, consider the following:

1. Determine the name of the application.
2. If you are using images for OAuth, have the graphic file (256x256, or 512x512) available for upload (you also have an option to upload it later).
3. Review the Syncplicity APIs to identify the ones you plan to use.
4. 
5. Optionally, download to jump start development.

Registering an application

To register your application:

1. Click Create application.
2. Complete the form.
3. Click Save application to create.

Generate keys and manage settings

After the application is created, you need to generate the OAuth keys (client id and secret).

1. Click Generate to generate the keys.
2. Configure the list of JavaScript origins allowed to access resources configured with this cross-origin resource sharing (CORS) profile.
3. Optionally, provide redirect URLs. This is needed for three-legged auth code OAuth 2.0 grant.

To view the app secret, select the Actions drop-down and click View Secret. The following table describes the fields.

Monitoring application usage

Once your application has been defined, click View metrics to see the the following usage:

• Message count
• Processing time
• Exceptions percentage
• Failures percentage

Useful links

• Getting started with Syncplicity API
• API Demo
• Syncplicity APIs Solution brief