Terminology
Config
A customer’s preference for which objects and fields they want your application to read or write, and fields they’ve mapped. Each Installation has its own Config.
Connection
A connection is a SaaS credential that Ampersand stores and manages which allows an integration to read or write data to or from a SaaS instance.
Consumer
A consumer is an individual end user that installs an integration.
Group
A group could be a company, team, or workspace within your app. All member of the group has access to its integrations, and only one member needs to install an integration for all members of the group to access it.
Manifest
The manifest file is a YAML file called amp.yaml that defines your integrations. You only have to define your integrations once across all your customers.
Installation
An installation is an instance of an integration, for a particular customer. Learn more on the Concepts page.
Integration
An integration defines how your application will interact with a third party SaaS tool. Learn more on the Concepts page.
Operation
An Operation happens every time there’s a read, or write, or proxy API request to a third party API provider. You can view Operations in the Ampersand Dashboard, or query for them using the operation endpoints.
Primary key
The primary key is a UID generated by a SaaS provider (e.g. Salesforce) to uniquely identify an instance of an object.
Examples:
For Salesforce, it is the ID field, which is a standard field for almost all objects.
For Hubspot, each object has an ID, for example Contact has a Contact ID.
Project
A project contains one or more integrations and their related data. An org can have one or more projects. Each project is uniquely identified by:
- A project name is chosen at the time of project creation, it must be globally unique and can contain numbers, letters and dashes, and is case insensitive.
- A project ID which is assigned by Ampersand at the time of project creation.
Different projects can be used to represent different environments, learn more in Dev and prod environments.
Provider
A provider is a third-party API that Ampersand integrates with.
Provider app
A provider app describes the information that Ampersand stores about an OAuth app that is first created in a third party’s system. For example, to integrate with Salesforce, you need to first create a Salesforce Connected App in the Salesforce Dashboard, and then create a Provider App in the Ampersand Dashboard with the Client ID and Client Secret from the Salesforce Connected App. For more information about how to create Provider Apps, refer to the provider guides.
Revision
A revision is a particular version of an integration’s definition. You create a new revision every time you modify the amp.yaml file and deploy the change via the amp CLI.