# ReCharge

The tap-recharge extractor pulls data from the ReCharge API.

To learn more about tap-recharge, refer to the repository at https://github.com/singer-io/tap-recharge.

# Getting Started

# Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

# Installation and configuration

# Using the Command Line Interface

  1. Add the tap-recharge extractor to your project using meltano add:

    meltano add extractor tap-recharge
    
  2. Configure the settings below using meltano config.

# Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
    
  2. Open the Extractors interface at http://localhost:5000/extractors.

  3. Click the "Add to project" button for "ReCharge".

  4. Configure the settings below in the "Configuration" interface that opens automatically.

# Next steps

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

# Settings

tap-recharge requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents in the sidebar.

# Minimal configuration

A minimal configuration of tap-recharge in your meltano.yml project file will look like this:






 
 

plugins:
  extractors:
  - name: tap-recharge
    variant: singer-io
    pip_url: tap-recharge==1.0.3
    config:
      start_date: '2020-10-01T00:00:00Z'

Sensitive values are most appropriately stored in the environment or your project's .env file:

export TAP_RECHARGE_ACCESS_TOKEN=my_access_token

# Access Token

Private API token

# How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-recharge set access_token <token>

export TAP_RECHARGE_ACCESS_TOKEN=<token>

# Start Date

This property determines how much historical data will be extracted.

Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

# How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-recharge set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_RECHARGE_START_DATE=YYYY-MM-DDTHH:MM:SSZ

# For example:
meltano config tap-recharge set start_date 2020-10-01T00:00:00Z

export TAP_RECHARGE_START_DATE=2020-10-01T00:00:00Z

# User Agent

User agent to send to ReCharge along with API requests. Typically includes name of integration and an email address you can be reached at, e.g. tap-recharge via Meltano <user@example.com>.

# How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-recharge set user_agent <user_agent>

export TAP_RECHARGE_USER_AGENT=<user_agent>