/tap-selligent

A Singer.io Tap for extracting data from the Selligent API

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

tap-selligent

Author: Connor McArthur (connor@fishtownanalytics.com)

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

This tap:

  • Pulls raw data from Selligent's API
  • Extracts the following resources:
    • Programs
    • Transactional Mailings
    • Data sources (internal & external)
  • Outputs the schema for each resource
  • Writes all data on each run

Quick start

  1. Install

    > pip install tap-selligent

  2. Get credentials from Selligent:

    You'll need:

    • Your Selligent organization name (if you aren't sure, contact your account manager)
    • An API key for your organization
    • The base URL for your Selligent installation

  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.

    • organization, your Selligent organization name (looks like "Organization")
    • api_key, your API Key
    • base_url, the base URL of your Selligent installation (looks like "https://organization.yourhost.com:443")
    • user_agent, the user-agent to set as a header on all requests made. Include your email address. (example: "tap-selligent (you@yourdomain.com)")
    • start_date, the date from which you want to sync data, in the format 2017-03-10.

  4. Run the application.

    tap-selligent --config config.json

Copyright © 2017 Stitch