DDx API Accounts, Workspaces & Apps

A Workspace is your organization's shared space in the DDx API Console. Users belong to their organization's Workspace and use it to access DDx API's products and services.

Users also have a personal workspace, which they can use as a private sandbox for testing the DXAPI.

Overview

Three core concepts / models shape how you work in the DDx API Console:

• Workspaces are your home base in the Console, where you create and manage Apps, generate API keys, and control access to data. Every user has a Personal Workspace, but most work happens in shared Organizational Workspaces. Every Workspace has a unique ID.
• Apps are the integrations that a tech partner builds to move data through a DDx API. An App behaves differently depending on which API it targets: the Dataset Exchange API handles bulk dataset sharing (reference), while the Interactions API streams voter and supporter interaction data from a Source to one or more Destinations (reference). API keys are issued per App.
• App Environments tag each App as Development or Production at creation time. The environment is permanent and determines whether an App can be shared beyond its own Workspace and whether it surfaces in the Admin API.

In this guide

• Workspaces: Types of Workspaces and how they relate
• Apps: What Apps are and how they differ between the Dataset Exchange API & Interactions APIs
• Set Up A New Personal Workspace
• Add or Set Up A New Organizational Workspace
• Workspace Role Definitions
• App Environments and Sharing Rules