Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imryan/paybear-ios
🐻 Paybear API on iOS
https://github.com/imryan/paybear-ios
api cryptocurrencies cryptocurrency market-exchange-rates paybear paybear-api
Last synced: 26 days ago
JSON representation
🐻 Paybear API on iOS
- Host: GitHub
- URL: https://github.com/imryan/paybear-ios
- Owner: imryan
- License: mit
- Created: 2018-02-25T20:55:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-03T15:11:49.000Z (over 5 years ago)
- Last Synced: 2024-09-23T19:02:16.415Z (about 2 months ago)
- Topics: api, cryptocurrencies, cryptocurrency, market-exchange-rates, paybear, paybear-api
- Language: Swift
- Homepage: https://www.paybear.io/
- Size: 125 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🐻 Paybear iOS
[](https://travis-ci.org/imryan/paybear-ios)
[](http://cocoapods.org/pods/paybear-ios)
[](http://cocoapods.org/pods/paybear-ios)
[](http://cocoapods.org/pods/paybear-ios)
[](http://makeapullrequest.com)
## ⚠️ IMPORTANT
* This pod has been deprecated. It has been continued [here](https://github.com/imryan/savvy-ios).
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Usage
#### Set Paybear API key
```swift
Paybear.shared.setToken("your-api-key")
```
#### Get current market prices
```swift
Paybear.shared.getCurrencies(completion: { (currencies, error) in
if let currencies = currencies, error == nil {
// Array of currency. Nice
}
})
```
#### Get market exchange rates for all cryptocurrencies
```swift
Paybear.shared.getMarketRates(fiat: .usd) { (rates, error) in
if let rates = rates, error == nil {
// ...
}
}
```
#### Get single market exchange rate for cryptocurrency
```swift
Paybear.shared.getSingleMarketRate(fiat: .usd, crypto: .btc) { (rate, error) in
if let rate = rate, error == nil {
// ...
}
}
```
#### Create payment request in given cryptocurrency
```swift
Paybear.shared.createPaymentRequest(crypto: .btc, callbackURL: "http://ryans.online") { (request, error) in
if let request = request, error == nil {
// ...
}
}
```
#### Create payment request as QR code image
```swift
Paybear.shared.getPaymentRequestQR(crypto: .btc, amount: 1.0, address: "123", message: "Free money", size: nil) { (image) in
if let image = image {
// QR code image containing a payment URL
}
}
```
#### Login a user
```swift
Paybear.shared.login(email: "[email protected]", password: "password", twoFactorDelegate: nil) { (token, error) in
if let token = token, error == nil {
// We can now make user-based requests with our stored token!
}
}
```
#### Another way to login a user
Utilize the `TwoFactorAuthProtocol` to receive a callback when a 2FA code is requested.
```swift
Paybear.shared.login(email: "[email protected]", password: "password", twoFactorDelegate: self) { (token, error) in
if let token = token, error == nil {
// We can now make user-based requests with our stored token!
}
}
```
```swift
func paybearDidRequestTwoFactorAuthentication() {
// Prompt for 2FA code here
Paybear.shared.loginTwoFactor(code: "123456") { (success) in
if success {
// We have completed the login process
}
}
}
```
#### Post-login two-factor authentication
```swift
Paybear.shared.loginTwoFactor(code: "123456") { (success) in
if success {
// We have completed the login process
// Best to call this function on login completion
}
}
```
#### Get user properties
```swift
Paybear.shared.getUser(completion: { (user, error) in
if let user = user, error == nil {
// We've got a valid user object!
}
})
```
#### Enable or disable a currency on the dashboard
```swift
Paybear.shared.enableCurrency(.btc, enable: true, address: "123", completion: { (success) in
if success {
// Enabled BTC with wallet address 123
}
})
```
## Requirements
* Alamofire
* Quick/Nimble (to run tests only)
## Installation
paybear-ios is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'paybear-ios'
```
## Author
Ryan Cohen, [email protected]
## License
paybear-ios is available under the MIT license. See the LICENSE file for more info.