Repository files navigation

Author: Drew Banin (drew@fishtownanalytics.com)

This is aSinger tap that produces JSON-formatted data following theSinger 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

git clone git@github.com:fishtown-analytics/tap-ringcentral.gitcd tap-ringcentralpip install.

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

To create a new application, navigate to theRingCentral Developer Console and clickCreate 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

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.

The following permissions are required:

• Read Accounts
• Read Call Log
• Read Messages

There is a template you can use atconfig.json.example, just copy it toconfig.json in the repo root and insert your credentials. You will initially need to use the sandboxapi_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.

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

Step 4 a file calledcatalog.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 theSinger guide on Catalog Format for more information on how tables are selected.

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

Copyright © 2019 Stitch