-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates to setup guides for APIs (#26870)
* Updates to API docs * Updates from review * resolve conflits * Update Asana doc * Revert Asana * Add note on multiple projects
- Loading branch information
1 parent
cb8a166
commit 3476a81
Showing
11 changed files
with
196 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## Prerequisites | ||
|
||
* OAuth access or a Personal Access Token | ||
|
||
## Setup guide | ||
1. Enter a name for your source | ||
2. Authenticate using OAuth (recommended) or enter your `personal_access_token`. Please follow these [steps](https://developers.asana.com/docs/personal-access-token) to obtain a Personal Access Token for your account. | ||
3. Click **Set up source** | ||
|
||
### Syncing Multiple Projects | ||
If you have access to multiple projects, Airbyte will sync data related to all projects you have access to. The ability to filter to specific projects is not available at this time. | ||
|
||
For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for [Asana](https://docs.airbyte.com/integrations/sources/asana). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
## Prerequisites | ||
|
||
* BambooHR [API Key](https://documentation.bamboohr.com/docs#authentication) | ||
|
||
|
||
## Setup guide | ||
1. Name your BambooHR connector | ||
2. Enter your `api_key`. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient administrator permissions, there will be an "API Keys" option in that menu to go to the page. | ||
3. Enter your `subdomain`. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany" | ||
4. (Optional) Enter any `Custom Report Fields` as a comma-separated list of fields to include in your custom reports. Example: `firstName,lastName`. If none are listed, then the [default fields](https://documentation.bamboohr.com/docs/list-of-field-names) will be returned. | ||
5. Toggle `Custom Reports Include Default Fields`. If true, then the [default fields](https://documentation.bamboohr.com/docs/list-of-field-names) will be returned. If false, then the values defined in `Custom Report Fields` will be returned. | ||
6. Click **Set up source** | ||
|
||
For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for [BambooHR](https://docs.airbyte.com/integrations/sources/bamboo-hr). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
## Prerequisites | ||
* [Microsoft developer token](https://docs.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13#get-developer-token) of an authorized Bing Ads OAuth application | ||
|
||
To use the Bing Ads API, you must have a developer token and valid user credentials. You will need to register an OAuth app to get a refresh token. | ||
1. [Register your application](https://docs.microsoft.com/en-us/advertising/guides/authentication-oauth-register?view=bingads-13) in the Azure portal. | ||
2. [Request user consent](https://docs.microsoft.com/en-us/advertising/guides/authentication-oauth-consent?view=bingads-13l) to get the authorization code. | ||
3. Use the authorization code to [get a refresh token](https://docs.microsoft.com/en-us/advertising/guides/authentication-oauth-get-tokens?view=bingads-13). | ||
|
||
:::note | ||
|
||
The refresh token expires every 90 days. Repeat the authorization process to get a new refresh token. The full authentication process described [here](https://docs.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13#access-token). | ||
Please be sure to authenticate with the email (personal or work) that you used to sign in to the Bing ads/Microsoft ads platform. | ||
::: | ||
|
||
4. Request your [Microsoft developer token](https://docs.microsoft.com/en-us/advertising/guides/get-started?view=bingads-13#get-developer-token) in the Microsoft Advertising Developer Portal account tab. | ||
|
||
|
||
## Setup guide | ||
1. Enter a name for your source. | ||
2. Enter the developer token | ||
3. For **Tenant ID**, enter the custom tenant or use the common tenant. If your OAuth app has a custom tenant and you cannot use Microsoft’s recommended common tenant, use the custom tenant in the Tenant ID field when you set up the connector. | ||
|
||
:::info | ||
The custom tenant is used in the authentication URL, for example: `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/authorize` | ||
|
||
::: | ||
|
||
4. For **Replication Start Date**, enter the date in YYYY-MM-DD format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. | ||
5. For **Lookback window** (also known as attribution or conversion window), enter the number of **days** to look into the past. If your conversion window has an hours/minutes granularity, round it up to the number of days exceeding. If you're not using performance report streams in incremental mode, let it with 0 default value. | ||
6. Click **Authenticate your Bing Ads account** and authorize your account. | ||
8. Click **Set up source**. | ||
|
||
For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for [Bing Ads](https://docs.airbyte.com/integrations/sources/bing-ads). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
## Prerequisites | ||
|
||
* [Sendgrid API Key]((https://docs.sendgrid.com/ui/account-and-settings/api-keys#creating-an-api-key)) with | ||
* Read-only access to all resources | ||
* Full access to marketing resources | ||
|
||
## Setup guide | ||
|
||
1. Enter a name for your Sendgridconnector. | ||
2. Enter your `api key`. | ||
3. (Optional) Enter the `start_time` in YYYY-MM-DDTHH:MM:SSZ format. Dataadded on and after this date will be replicated. If this field is blank, Airbyte will replicate all data. | ||
4. Click **Set up source**. | ||
|
||
### (Optional) Create a read-only API key | ||
|
||
While you can set up the Sendgrid connector using any Salesforce user with read permission, we recommend creating a dedicated read-only user for Airbyte. This allows you to granularly control the which resources Airbyte can read. | ||
|
||
The API key should be read-only on all resources except Marketing, where it needs Full Access. | ||
|
||
Sendgrid provides two different kinds of marketing campaigns, "legacy marketing campaigns" and "new marketing campaigns". **Legacy marketing campaigns are not supported by this source connector**. | ||
If you are seeing a `403 FORBIDDEN error message for https://api.sendgrid.com/v3/marketing/campaigns`, it may be because your SendGrid account uses legacy marketing campaigns. | ||
|
||
For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for [Sendgrid](https://docs.airbyte.com/integrations/sources/sendgrid). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
## Prerequisites | ||
|
||
* An Active [Shopify store](https://www.shopify.com) | ||
* The Admin API access token of your [Custom App](https://help.shopify.com/en/manual/apps/app-types/custom-apps). | ||
|
||
:::note | ||
|
||
Our Shopify Source Connector does not support OAuth at this time due to limitations outside of our control. If OAuth for Shopify is critical to your business, [please reach out to us](mailto:product@airbyte.io) to discuss how we may be able to partner on this effort. | ||
|
||
::: | ||
|
||
## Setup guide | ||
|
||
1. Name your source. | ||
2. Enter your Store name. You can find this in your URL when logged in to Shopify or within the Store details section of your Settings. | ||
3. Enter your Admin API access token. To set up the access token, you will need to set up a custom application. See instructions below on creating a custom app. | ||
4. Click Set up source | ||
|
||
## Creating a Custom App | ||
Authentication to the Shopify API requies a [custom application](https://help.shopify.com/en/manual/apps/app-types/custom-apps). Follow these instructions to create a custom app and find your Admin API Access Token. | ||
|
||
1. Navigate to Settings > App and sales channels > Develop apps > Create an app | ||
2. Name your new app | ||
3. Select **Configure Admin API scopes** | ||
4. Tick all the scopes prefixed with `read_` (e.g. `read_locations`,`read_price_rules`, etc ) and save. See below for the full list of scopes to allow. | ||
5. Click **Install app** to give this app access to your data. | ||
6. Once installed, go to **API Credentials** to copy the **Admin API Access Token**. | ||
|
||
### Scopes Required for Custom App | ||
Add the following scopes to your custom app to ensure Airbyte can sync all available data. To see a list of streams this source supports, see our full [Shopify documentation](https://docs.airbyte.com/integrations/sources/shopify/). | ||
* `read_analytics` | ||
* `read_assigned_fulfillment_orders` | ||
* `read_gdpr_data_request` | ||
* `read_locations` | ||
* `read_price_rules` | ||
* `read_product_listings` | ||
* `read_products` | ||
* `read_reports` | ||
* `read_resource_feedbacks` | ||
* `read_script_tags` | ||
* `read_shipping` | ||
* `read_locales` | ||
* `read_shopify_payments_accounts` | ||
* `read_shopify_payments_bank_accounts` | ||
* `read_shopify_payments_disputes` | ||
* `read_shopify_payments_payouts` | ||
* `read_content` | ||
* `read_themes` | ||
* `read_third_party_fulfillment_orders` | ||
* `read_translations` | ||
* `read_customers` | ||
* `read_discounts` | ||
* `read_draft_orders` | ||
* `read_fulfillments` | ||
* `read_gift_cards` | ||
* `read_inventory` | ||
* `read_legal_policies` | ||
* `read_marketing_events` | ||
* `read_merchant_managed_fulfillment_orders` | ||
* `read_online_store_pages` | ||
* `read_order_edits` | ||
* `read_orders` | ||
|
||
| ||
For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for [Shopify](https://docs.airbyte.com/integrations/sources/shopify). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters