-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
source-workflowmax contribution from btkcodedev (#46866)
Co-authored-by: Octavia Squidington III <[email protected]>
- Loading branch information
1 parent
9344610
commit bda5ae0
Showing
6 changed files
with
2,457 additions
and
0 deletions.
There are no files selected for viewing
55 changes: 55 additions & 0 deletions
55
airbyte-integrations/connectors/source-workflowmax/README.md
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,55 @@ | ||
# Workflowmax | ||
This directory contains the manifest-only connector for [`source-workflowmax`](https://app.workflowmax2.com/). | ||
|
||
## Documentation reference: | ||
Visit `https://app.swaggerhub.com/apis-docs/WorkflowMax-BlueRock/WorkflowMax-BlueRock-OpenAPI3/0.1#/` for V1 API documentation | ||
|
||
## Authentication setup | ||
`Workflowmax` uses bearer token authentication, You have to input your bearer access_token in the field of API key for authentication. | ||
|
||
### Using postman to get access token | ||
- Move to Authorization tab of an empty http request and selected Oauth 2.0 | ||
- Set use token type as `access token` | ||
- Set header prefix as `Bearer` | ||
- Set grant type as `Authorization code` | ||
- Check `Authorize using browser` | ||
- Set Auth URL as `https://oauth.workflowmax2.com/oauth/authorize` | ||
- Set Access token URL as `https://oauth.workflowmax2.com/oauth/token` | ||
- Set Client ID, Client secret, Scope defined as your Workflowmax settings, Example Scope: `openid profile email workflowmax offline_access` | ||
- Set state as any number, Example: `1` | ||
- Set Client Authentication as `Send as Basic Auth Header` | ||
Click `Get New Access Token` for retrieving access token | ||
|
||
Then authorize your source with the required information. | ||
1. Go to set up `The Source` page. | ||
2. Enter your Workflowmax application's access token. | ||
3. Click Save button. | ||
|
||
## Usage | ||
There are multiple ways to use this connector: | ||
- You can use this connector as any other connector in Airbyte Marketplace. | ||
- You can load this connector in `pyairbyte` using `get_source`! | ||
- You can open this connector in Connector Builder, edit it, and publish to your workspaces. | ||
|
||
Please refer to the manifest-only connector documentation for more details. | ||
|
||
## Local Development | ||
We recommend you use the Connector Builder to edit this connector. | ||
|
||
But, if you want to develop this connector locally, you can use the following steps. | ||
|
||
### Environment Setup | ||
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci). | ||
|
||
### Build | ||
This will create a dev image (`source-workflowmax:dev`) that you can use to test the connector locally. | ||
```bash | ||
airbyte-ci connectors --name=source-workflowmax build | ||
``` | ||
|
||
### Test | ||
This will run the acceptance tests for the connector. | ||
```bash | ||
airbyte-ci connectors --name=source-workflowmax test | ||
``` | ||
|
17 changes: 17 additions & 0 deletions
17
airbyte-integrations/connectors/source-workflowmax/acceptance-test-config.yml
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,17 @@ | ||
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) | ||
# for more information about how to configure these tests | ||
connector_image: airbyte/source-workflowmax:dev | ||
acceptance_tests: | ||
spec: | ||
tests: | ||
- spec_path: "manifest.yaml" | ||
connection: | ||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time" | ||
discovery: | ||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time" | ||
basic_read: | ||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time" | ||
incremental: | ||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time" | ||
full_refresh: | ||
bypass_reason: "This is a builder contribution, and we do not have secrets at this time" |
Oops, something went wrong.