An open API service indexing awesome lists of open source software.

https://github.com/vapor-community/gatewayapikit

A Swift package for sending SMS using GatewayAPI
https://github.com/vapor-community/gatewayapikit

gateway-api server-side-swift sms-api swiftnio

Last synced: 3 months ago
JSON representation

A Swift package for sending SMS using GatewayAPI

Awesome Lists containing this project

README

          

# GatewayAPIKit

### GatewayAPIKit is a Swift package used to send text messages (SMS) with [GatewayAPI](https://gatewayapi.com/) for Server Side Swift.

## Installation
To use GatewayAPI, please add the following to your `Package.swift` file.

~~~~swift
dependencies: [
...
.package(url: "https://github.com/vapor-community/GatewayAPIKit.git", from: "1.0.0")
],
...
targets: [
.target(
name: ...
dependencies: [
...
.product(name: "GatewayAPIKit", package: "GatewayAPIKit")
]
)
]
~~~~

## How to use
All you need to send a text message is to initialize a `GatewayAPIClient`:

~~~~swift
import GatewayAPIKit

let eventLoop: EventLoop = ...
let httpClient = HTTPClient(...)
let client = GatewayAPIClient(eventLoop: eventLoop, httpClient: httpClient, apiKey: "")
~~~~

Please store your API key in storage such as environment variables and not directly in code.

You can now send a simple text message:
~~~~swift
client.send("My text message", to: ["4510203040"], from: "Mads")
~~~~