Integrating third-party services in the servercloud version

If you decide to connect a third-party service to portal, proceed through these simple steps

1. First of all go to the Settings section. To do that click the icon in the right upper corner.

2. Switch to the Integration tab.

3. Open the Third-Party Services page.

   In this section you will see all the third-party services you can connect your portal to. The most important part in the process of establishing the connection is to find application keys. If you want to connect a third-party service to your portal, first of all get the application ID (may be called app key, client_id, api key etc.) and Key (app secret, client_secret, api secret etc.). The way to obtain the connection keys differs from service to service. So choose the necessary service and follow the instructions:

   Amazon AWS S3

   1. Go to the AWS Management Console;
   2. Sign in to your account as a Root user;
   3. Click your account name on the top and select the My Security Credentials option;
   4. Expand the Access keys (access key ID and secret access key) section;
   5. Click the Create New Access Key button,
   6. In a new window, click the Show Access Key link. Copy or write down the Access Key ID and Secret Access Key.

   Apple

   1. Go to the Apple Developers Portal;
   2. Sign in to your account;
   3. Get an App ID:
      1. Go to Certificates, Identifiers & Profiles -> Identifiers and click the + icon in the upper left corner.
      2. Select App IDs and click Continue.
      3. Enter a Description and a Bundle ID (a reverse-domain name style string: com.domainname.appname). Make sure that Sign In with Apple is checked. Click Continue and click Register.
   4. Get a Services ID:
      1. Go to Certificates, Identifiers & Profiles -> Identifiers and click the + icon in the upper left corner.
      2. Select Services IDs and click Continue.
      3. Enter a Description and an Identifier (a reverse-domain name style string: com.domainname.appname). Make sure that Sign In with Apple is checked. Click the Configure button next to Sign In with Apple.
      4. Make sure the App ID is selected as the Primary App ID. Add the Return URLs "https://service.onlyoffice.com/oauth2.aspx". Click Save.
      5. Click Continue and click Register.
   5. Create a private key:
      1. Go to Certificates, Identifiers & Profiles -> Keys and click the + icon in the upper left corner.
      2. Enter a unique name for the key. Make sure that Sign In with Apple is checked.
      3. Click Configure. In the Choose a Primary App ID field, select the App ID and click Save.
      4. Click Continue and click Register.
      5. Click Download to download the private key.
   6. Get a key identifier:
      1. Go to Certificates, Identifiers & Profiles -> Keys.
      2. Select the private key on the right.
      3. The key identifier will be displayed below the key name.

   Bitly

   1. Go to the Bitlink Management page;
   2. Sign in to your account;
   3. Generate your Generic Access Token:
      1. follow this link or go to Profile Settings -> Generic Access Token;
      2. confirm your account password in the entry field;
      3. click the Generate token button.
   4. Your Generic Access Token will appear in the pop-up window. Click the Copy button to copy it to the clipboard.

   Box.com

   1. Go to the box developers page;
   2. Sign in to your account;
   3. Click the Create new app button on the right;
   4. On a new page that opens, select the Custom app application type and choose the User Authentication (OAuth 2.0) method;
   5. Enter a unique name for your application in the entry field below and click the Create App button;
   6. On the opened Configuration page, in the OAuth 2.0 Redirect URI section, enter "https://service.onlyoffice.com/oauth2.aspx" in the Redirect URI field;
   7. In the Application Scopes -> Content Actions section, check the Write all files and folders stored in Box checkbox;
   8. In the OAuth 2.0 Credentials section, copy or write down the Client ID and Client secret;
   9. Save the changes made clicking the Save Changes button in the upper right corner of the page.

   Clickatell

   1. Sign in to your Clickatell account.
   2. Go to Channels -> SMS and click + Activate channel.
   3. Click + New SMS Setup. Choose API -> One-way and click Next.
   4. Select Basic HTTP API -> Create a new HTTP API and click Next.
   5. Specify Setup Name, select SMS Service Class and Setup Type, then click Next.
   6. Copy API Key and click Complete.

   DocuSign

   1. Go to the Admin console of the DocuSign sandbox.
   2. Sign in to your sandbox account.
   3. In the left-side menu, find the Integrations section and open the Apps and Keys page.
   4. Click the Add App and Integration Key button.
   5. Type in your application name and click the Create app button.
   6. Your app settings page will open.
   7. In the General Info -> Integration Key section, copy or write down your Integration key.
   8. In the Authentication -> Secret Keys section, click the Add Secret Key button and copy or write down the Secret Key that will be displayed above.
   9. In the Additional settings -> Redirect URIs section, click the Add URI button and add "https://service.onlyoffice.com/oauth2.aspx" in the field that appears.
   10. Click the Save button.
   11. Use the "account-d.docusign.com" value as the Authentication endpoint.

       If your application has been moved from the sandbox to a live production account, use the "account.docusign.com" value as the Authentication endpoint.

       For the details on how to move your sandbox Integrator Key to a live production account you can refer to the official DocuSign documentation

   Dropbox

   1. Go to Dropbox Developers website;
   2. Sign in to your account;
   3. Click the Create your app link;
   4. Next check the Dropbox API radio button;
   5. Select the following type of access:
      • Full Dropbox - Access to all files and folders in a user's Dropbox.
   6. Introduce your application name;
   7. Click the Create app button;
   8. On your application 'Settings' tab, enter "https://service.onlyoffice.com/oauth2.aspx" in the 'Redirect URIs' field and click the Add button;
   9. Copy or write down App key and App secret which appear on the 'Settings' page.
   10. Go to the Permissions tab. In the Files and folders section, activate the "files.metadata.read" checkbox. Click Submit at the bottom of the screen.

   EasyBib

   This service can be connected within the corresponding plugin at the Plugins tab of the Document Editor.

   If you have the EasyBib API key generated earlier, you can continue using it, but you cannot generate new ones, as API access is no longer offered or supported by EasyBib.
   1. Go to the EasyBib signup page;
   2. Fill in the form:
      • specify your Name and Email,
      • specify your application Name and Description,
      • in the URL field, introduce "https://service.onlyoffice.com/oauth2.aspx",
      • accept the Terms of service and click Submit.
   3. You will receive the confirmation message to the specified email address. Follow the confirmation link;
   4. After that you will receive another email message with your application information. Copy or write down the apikey.
   The EasyBib plugin is not included in the free version of the editors.

   Facebook

   1. Go to Facebook Developers Portal;
   2. Sign in to your account;
   3. Click the My Apps link in the upper right corner and click the Create App button;
   4. Select the Consumer app type and click the Next button;
   5. Enter your application name in the Display name field and verify your App contact email specified by default;
   6. Click the Create app button;
   7. You will be redirected to the + Add Product page. Move the mouse cursor over the Facebook Login section and click the Set up button;
   8. Provide both a valid Privacy Policy URL and data deletion information in the Settings -> Basic section;
   9. The Facebook Login product will appear in the Products section of left-side menu. Click the Settings link below the Facebook Login product. Find the Client OAuth Settings section;
   10. Introduce https://service.onlyoffice.com/oauth2.aspx in the Valid OAuth redirect URIs field;
   11. Click the Save changes button in the lower right corner;
   12. Switch your App Mode from Developer to Live using the switcher on the top panel.

       Alternatively, you can add users who will use Facebook Login to Testers for this app:

       1. Go to the Roles section in the left-side menu.
       2. In the Testers sections, add all users one by one specifying their Facebook IDs.
       3. All users must be verified as developers on Facebook and accept the requests.
   13. On the left-side panel, open the Settings -> Basic section;
   14. Copy or write down your App ID and App Secret.

   Firebase

   1. Go to Firebase console.
   2. Sign in to your account.
   3. Click the Add project button.
   4. Enter your project name in the Project name field or select one of the existing Google Cloud projects.
   5. Click Continue in the wizard, then click Create project. Once the project is created, click Continue.
   6. Click the Settings icon in the upper left part of the page and then click the Project settings menu item.
   7. In the General section, copy or write down the Project ID.
   8. Switch to the Cloud Messaging section and copy or write down the Sender ID.
   9. To get the Server key, generate a key pair below and copy the public key.
   10. To find your Web API Key, go to Google Cloud Platform console, find your project and go to APIs & Services > Credentials. Copy the Browser key (Auto created by Firebase).

   Google

   Use this instruction if you want to connect your Google Drive account with the Documents module, sign in to ONLYOFFICE via your Google account, and import new users from the contact list.

   1. Go to Google Cloud Platform console.
   2. Sign in to your account.
   3. Click the Create project button. Enter the Project Name in the corresponding field and click the Create button. Once the project is created, you'll see a notification in the upper right corner of the page. Click on the project name to open it.
   4. Enable necessary APIs:
      • Click the navigation menu in the upper left corner and select the APIs and services -> Enabled APIs and services.
      • Click the Enable APIs and services button on the top.
      • In the Google Workspace section, click the Google Drive API link, then click the Enable button.
      • Return to the Enabled APIs and services page, click the Enable APIs and services button. In the Social section, enable the Google People API and Contacts API in the same way.
   5. Configure the OAuth consent screen, add a scope and test users:
      • From the left navigation menu, select the OAuth consent screen section.
      • Choose the User Type and click Create.
      • In the App information section, specify the App name and User support email in the corresponding fields.
      • In the App domain section, go to the Authorized domains subsection. Click the Add domain button and specify the onlyoffice.com domain in the entry field.
      • Specify an email in the Developer contact information section.
      • Click the Save and continue button.
      • Click the Add or remove scopes button. On a new screen that opens, go to the Manually add scopes section, specify https://www.googleapis.com/auth/drive in the entry field and click the Add to table button, then click Update.
      • Click the Save and continue button.
      • In the Test users section, click the Add users button. Specify necessary Google accounts and click the Add button.
      • Click the Save and continue button.
   6. Get Client ID and Client secret:
      • From the left navigation menu, select the Credentials section.
      • Click the Create credentials button and choose the OAuth client ID option in the list.
      • In the Application type list, select the Web application option.
      • In the Authorized JavaScript origins section, click the Add URI button and enter "https://service.onlyoffice.com" in the entry field.
      • In the Authorized redirect URIs section, click the Add URI button and enter "https://service.onlyoffice.com/oauth2.aspx" in the entry field.
      • Click the Create button.
      • Your Client ID and Client secret will be displayed in a new window. Copy or write down them.

   Google Cloud Storage

   Use this instruction if you want to connect Google Cloud Storage service to backup and store data from your portal.

   1. Go to Google Cloud Platform console.
   2. Sign in to your account.
   3. Click the navigation menu in the upper left corner and select the IAM & admin -> Service accounts section.
   4. Select an existing project or create a new one.
   5. Click the Create service account button.
   6. Specify the Service account name and click Create.
   7. Select the Owner role and click Continue.
   8. Optionally, grant access to this service account to users: specify necessary Google accounts and click Done.
   9. On the Service accounts page, click the menu button in the Actions field and choose the Create key option.
   10. In a new window that opens, choose the JSON type and click Create.
   11. The .json file that contains the private key will be downloaded to your computer. To connect the GoogleCloud service, you will need to open this .json file with a text editor, copy its contents and paste into the json field on the portal.

   LinkedIn

   1. Go to LinkedIn Developers website;
   2. Sign in to your account;
   3. Click the Create application button;
   4. Fill out all the fields marked with the red sign and click the Submit button;
   5. Check the r_basicprofile and r_emailaddress options in the Default Application Permissions section;
   6. Introduce "https://service.onlyoffice.com/oauth2.aspx" in the Authorized redirect URLs field, click the Add button, then click Update at the bottom of the page to save the changes;
   7. Copy or write down the Client ID and Client Secret in the Authentication Keys section.

   Mail.ru

   1. Go to https://api.mail.ru/sites/my/.
   2. Sign in to your account.
   3. Click the Connect site button.
   4. Accept the terms of service checking the corresponding box and click the Continue button.
   5. Specify the site name.
   6. Specify https://service.onlyoffice.com/ as the main page URL address and click the Continue button.
   7. On the next screen, click the Continue button and skip downloading the receiver.html page.
   8. Copy the site ID and Secret key.
   9. Go to My sites and click the Manage link next to the site name.
   10. In the site settings, specify the following URL address of the receiver.html page: https://service.onlyoffice.com/receiver.html.
   11. Save the changes.

   Mendeley

   This service can be connected within the corresponding plugin at the Plugins tab of the Document Editor.

   1. Go to the Mendeley page and register a new account or log into an existing account;
   2. Proceed to My apps page and register a new app by filling the following fields:
      • specify the Application name,
      • add a Description for the application,
      • open the Mendeley plugin in the Plugins tab, copy the provided URL address. The address should look like this: https://your.portal/ds-vpath/5.5.3-39/sdkjs-plugins/mendeley/oauth.html,
      • accept the Terms and Conditions,
      • generate a Secret,
      • click the Submit button to add an application.
   3. Copy the generated id of the application, insert it into the Application ID field in the Document editor, and click the Save button;
   4. Continue by logging into your Mendeley account.

   Microsoft

   1. Go to Microsoft Azure.
   2. Sign in to your account.
   3. Сlick the New registration button at the App registrations page.
   4. Enter your application Name.
   5. Choose the platform (Web) and enter "https://service.onlyoffice.com/oauth2.aspx" in the Redirect URL field.
   6. Click the Register button at the bottom of the page;
   7. Copy or write down the Application (client) ID displayed at the Overview page.
   8. Switch to the Certificates & secrets section on the left.
   9. Click the New client secret button.
   10. Enter the description and click Add.
   11. Copy or write down the Client secret displayed in the Value field.

   OneDrive

   1. Go to Microsoft Azure.
   2. Sign in to your account.
   3. Сlick the New registration button at the App registrations page.
   4. Enter your application Name.
   5. Choose the platform (Web) and enter "https://service.onlyoffice.com/oauth2.aspx" in the Redirect URL field.
   6. Click the Register button at the bottom of the page;
   7. Copy or write down the Application (client) ID displayed at the Overview page.
   8. Switch to the Certificates & secrets section on the left.
   9. Click the New client secret button.
   10. Enter the description and click Add.
   11. Copy or write down the Client secret displayed in the Value field.

   Rackspace Cloud Storage

   1. Go to Rackspace Cloud Control Panel.
   2. Sign in to your account.
   3. Click the username menu in the upper right corner of the control panel.
   4. Select the My Profile & Settings option,
   5. Scroll down to Security Settings,
   6. Click the Show link next to Rackspace API Key.
   7. Copy or write down Rackspace API Key. To connect the Rackspace service, you'll also need to specify your Rackspace username, i.e. the username that you use to log in.

   Selectel Cloud Storage

   1. Sign in to your Selectel account;
   2. Go to the Cloud storage -> Users section;
   3. Choose the user who has corresponding access rights to the storage or create a new user providing him/her with Read and write access to the containers which will be used to store your backups;
   4. Copy the user login and enter it in the Selectel authUser field on the portal;
   5. Copy the user password and enter it in the Password to access the storage field on the portal.

   smsc

   1. Use your smsc account login;
   2. Use your password or password MD5 hash in lower case. To generate MD5 hash you can use the following link.
   3. Use your Sender ID. Sender ID can be registered in your account on this page.

   Telegram

   1. Open https://t.me/botfather using Telegram Desktop.
   2. Start BotFather using the following command:

      /start

   3. Create a new bot using the following command:

      /newbot

   4. Enter a name for your bot.
   5. Enter a username for your bot. It may only include Latin characters, numbers, and underscores and must end in 'bot', e.g. 'test_bot' or 'TestBot'.
   6. Copy the generated token.
   7. Paste the token and the bot username in the corresponding fields on the portal.

   Twilio

   1. Go to Twilio Console.
   2. Sign in to your account.
   3. Copy or write down the Account SID and Auth Token located in the Account Info section of the Account Dashboard.
   4. In the same section, copy the Twilio phone number that is required for the two-factor authentication.

   Twitter

   To successfully connect Twitter to your portal, Elevated Level API is required. You can obtain it via a separate request to Twitter.
   1. Go to Twitter Developers Portal.
   2. Sign in to your account.
   3. In the left menu, go to Projects & Apps: Overview and click the + Create App button.
   4. In the App name field, enter your application name and click Next.
   5. In the Keys & Tokens section, copy API Key, API Key Secret, Bearer Token.
   6. Click App settings.
   7. Click Set up in the User authentication settings section.
   8. In the App permissions block, select "Read and write and Direct message".
   9. In the Type of App block, select "Web App, Automated App or Bot".
   10. In the App info block, specify https://service.onlyoffice.com/oauth2.aspx in the Callback URI / Redirect URL line. In the Website URL line, specify URL of the website where Twitter is connected.
   11. Click Save.
   12. Save Client ID and Client Secret, click Done.

   VK

   1. Go to https://vk.com/apps?act=manage.
   2. Sign in to your account.
   3. Click the Create app link.
   4. Enter the app Title.
   5. In the Platform section, select Website.
   6. Specify the following Website address: https://service.onlyoffice.com.
   7. Specify the following Base domain: onlyoffice.com.
   8. Click the Connect website button.
   9. Link a device you want to use to manage the app if it is not linked yet.
   10. Open the notification sent to your device and follow the instructions. You’ll receive a call from a phone number that will be used as a confirmation code. Enter 4 last digits of the incoming phone number and click Confirm.
   11. Go to the app Settings.
   12. Specify https://service.onlyoffice.com/oauth2.aspx in the Authorized redirect URI field and click Save.
   13. Copy the App ID and Secure key.

   Wordpress

   This service can be connected within the corresponding plugin at the Plugins tab of the Document Editor.

   The Wordpress plugin is not included in the free version of the editors.
   1. Sign in to your Wordpress account. If you have not yet registered, go to the Wordpress signup page and fill in the registration form to create a new account. A new free website will be created together with your account;
   2. When you are signed in, go to the Wordpress Developers page;
   3. Fill in all the required fields to create a new application: specify your application Name, Description, Website URL;
   4. In the Redirect URLs field, introduce "https://service.onlyoffice.com/oauth2.aspx";
   5. Answer the verification question (e.g. 'What is 6 + 2?') and click the Create button;
   6. You will be redirected to the Manage Settings page. Click on your application name to display your application information;
   7. In the OAuth Information section, copy or write down the Client ID and Client Secret.

   Yahoo

   1. Sign in to your Yahoo account;
   2. Go to the Create Application page in the Yahoo Developer Network;
   3. Specify the Application Name;
   4. In the Redirect URI(s) field, introduce "https://service.onlyoffice.com/oauth2.aspx";
   5. In the API Permissions section, check the Contacts option;
   6. Click the Create App button;
   7. Copy or write down the Client ID and Client Secret.

   Yandex

   1. Go to https://oauth.yandex.com/.
   2. Sign in to your account.
   3. Click the Create app button.
   4. Specify the Service name.
   5. In the Platforms section, check the Web services option, click Save and continue.
   6. On the next screen, click Save and Continue.
   7. In the Redirect URI field, specify https://service.onlyoffice.com/oauth2.aspx and click the Save and continue button.
   8. Enter your company's or your personal email address and click the Save and continue button.
   9. Verify the settings and click Everything is correct. Create the app.
   10. Copy the ClientID and Client secret.

   Zotero

   This service can be connected within the corresponding plugin at the Plugins tab of the Document Editor.

   1. Go to the Zotero registration page and register a new account or log into an existing account;
   2. Proceed to Zotero API settings and click the Create new private key button;
   3. In the New private key page check the following checkboxes:
      • Personal Library - Allow write access,
      • Default Group Permissions - Read/Write.
   4. Click the Save Key button;
   5. Copy the generated key, insert it into the API Key field in the Document editor, and click the Save button;
4. To connect the necessary service click on the switcher next to it. A new window will open.

5. Introduce your received application ID and Key to the appropriate third-party fields.

6. Click the Enable button.

That's it! Now you can enjoy all the benefits of the Authorization keys option.