4858fbaf3b
* Initial implementation: Support for SMS API streams * Add connector documentation and icon * Add new SMS stream with associated stream slicer * add tyntec sms to source def * format files * auto-bump connector version Co-authored-by: marcosmarxm <marcosmarxm@gmail.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com> Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
65 lines
3.0 KiB
Markdown
65 lines
3.0 KiB
Markdown
# Tyntec SMS
|
|
|
|
## Overview
|
|
|
|
This page contains the setup guide and reference information for the [Tyntec SMS](https://api.tyntec.com/reference/sms/current.html#sms-api) source connector.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
A Tyntec SMS API Key and SMS message request ID are required for this connector to work. The API key can be generated by setting up a free Tyntec account. Be sure to pass the generated API key and message request ID when establishing the connection.
|
|
|
|
### Step 1: Set up a Tyntec SMS connection
|
|
|
|
1. Create a new Tyntec account [here](https://www.tyntec.com/create-account).
|
|
2. In the left navigation bar, click **API Settings** and navigate to **API Keys** to access your API key.
|
|
|
|
### Step 2: Set up a Tyntec SMS connector in Airbyte
|
|
|
|
#### For Airbyte Cloud:
|
|
|
|
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
|
|
3. On the Set up the source page, enter the name for the Tyntec SMS connector and select **Tyntec SMS** from the Source type dropdown.
|
|
4. Enter your `Tyntec API Key`.
|
|
5. Enter your `SMS Message Request ID`.
|
|
6. Click **Set up source**.
|
|
|
|
#### For Airbyte OSS:
|
|
|
|
1. Navigate to the Airbyte Open Source dashboard.
|
|
2. Set the name for your source.
|
|
3. Enter your `Tyntec API Key`.
|
|
4. Enter your `SMS Message Request ID`.
|
|
5. Click **Set up source**.
|
|
|
|
## Supported Sync Modes
|
|
|
|
The Tyntec SMS source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
|
|
|
| Feature | Supported? |
|
|
|:------------------|:-----------|
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental Sync | No |
|
|
|
|
## Supported Streams
|
|
|
|
Several output streams are available from this source:
|
|
|
|
- [SMS Message Status](https://api.tyntec.com/reference/sms/current.html#sms-api-Read%20SMS%20status)
|
|
- [SMS Contacts](https://api.tyntec.com/reference/sms/current.html#sms-api-List%20all%20contacts)
|
|
- [SMS Phone Numbers](https://api.tyntec.com/reference/sms/current.html#sms-api-List%20all%20phone%20numbers)
|
|
- [SMS Phone Registrations](https://api.tyntec.com/reference/sms/current.html#sms-api-List%20all%20phones)
|
|
|
|
If there are more endpoints you'd like Airbyte to support, please [create an issue](https://github.com/airbytehq/airbyte/issues/new/choose).
|
|
|
|
## Performance Considerations
|
|
|
|
The Tyntec SMS connector should not run into limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:---------------------------------------------------------|:------------------------------------------------|
|
|
| 0.1.0 | 2022-11-02 | [18883](https://github.com/airbytehq/airbyte/pull/18883) | 🎉 New Source: Tyntec SMS | |