isabella232 / tap-ringcentral

Singer.io tap for RingCentral

tap-ringcentral

Author: Drew Banin ([email protected])

This is a Singer tap that produces JSON-formatted data following the Singer spec.

It:

• Generates a catalog of available data in the RingCentral API
• Extracts the following resources:
  • Contacts
  • User Call Logs
  • Company Call Logs
  • SMS/MMS/Voicemal/Fax

Quick Start

1. Install

git clone [email protected]:fishtown-analytics/tap-ringcentral.git
cd tap-ringcentral
pip install .

2. Get credentials from RingCentral

Overview

• Create a new application and an associated sandbox account
• Note your client_id, client_secret, username, and password (used in the config.json file specified below)

Creating an application

To create a new application, navigate to the RingCentral Developer Console and click Create App. Make the application "Private" and select "Server-only (No UI)" as the Platform Type.

Your app will initially be created in a Sandbox. In order for your app to graduate from the Sandbox Environment to the Production Environment, you will need to (at the time of this writing):

1. Exercise each permission requested by the app
2. Maintain a < 5% error rate over the course of two days
3. Call each endpoint a mimimum of 20 times

Graduating to Production

Create contacts, calls, voicemails, SMS, and MMS messages in your Sandbox account, then run the tap a handful of times to meet these requirements. Once the graduation requirements are met, apply for Production and replace your Sandbox Credentials with the Prod credentials that you receive.

Permissions

The following permissions are required:

• Read Accounts
• Read Call Log
• Read Messages

3. Create the config file.

There is a template you can use at config.json.example, just copy it to config.json in the repo root and insert your credentials. You will initially need to use the sandbox api_url (eg. platform.devtest.ringcentral.com), but after graduating from the dev requirements, you will be able to switch this to use the production API endpoint.

4. Run the application to generate a catalog.

tap-ringcentral -c config.json --discover > catalog.json

5. Select the tables you'd like to replicate

Step 4 a file called catalog.json that specifies all the available endpoints and fields. You'll need to open the file and select the ones you'd like to replicate. See the Singer guide on Catalog Format for more information on how tables are selected.

6. Run it!

tap-ringcentral -c config.json --catalog catalog.json

Copyright © 2019 Stitch