0.1.0
📌
Quickstart Guides
📘
SDK Reference
🛡️ Protecting Your Account
🗝️ Getting Access Token
Sign In with Email/Phone Number
Our iOS SDK offers the easiest way to verify email/phone numbers in your Swift app. You can simply call a function and it does most of the heavy lifting and authentication for you.
Overview
Verifying email and phone number in your mobile app using our iOS SDK consists of the following steps:
- 1.Import Cotter
- 2.Call Cotter's Login function
- 3.Receive user's email or phone number, and whether or not it's verified
What you're building
Cotter's iOS SDK
Steps
- 4.
Step 1. Import Cotter as dependency
We use Cocoapods as our SDK host. If you're using Cocoapods, add this to your Podfile
1
pod 'Cotter'
Copied!
Then simply run
pod installStep 2. Initialize Cotter with your API Key
You will have to do
import Cotter on the file that will use Cotter. Then do initialization as follows1
import Cotter
2
3
...
4
5
let cotter = Cotter(
6
apiSecretKey: <your-api-secret-key>,
7
apiKeyID: <your-api-key-id>,
8
cotterURL: "https://www.cotter.app/api/v0",
9
userID: <your-user-id>, // user's id that will be created later
10
configuration: <your-cotter-config>
11
)
Copied!
example:
1
import Cotter
2
3
...
4
5
let cotter = Cotter(
6
apiSecretKey: "<API_SECRET_KEY>",
7
apiKeyID: "<API_KEY_ID>",
8
cotterURL: "https://www.cotter.app/api/v0",
9
userID: "[email protected]",
10
configuration: [:]
11
);
Copied!
Step 3. Call Cotter's login function
1
cotter.startPasswordlessLogin(
2
parentView: <your-view-controller>,
3
input: <your-input-text>,
4
identifierField: <identifier>,
5
type: <PHONE-or-EMAIL>,
6
directLogin: <true-or-false>,
7
cb: <your-callback>
8
)
Copied!
example:
1
@available(iOS 12.0, *)
2
class LoginViewController: UIViewController {
3
@IBOutlet weak var loginButton: UIButton!
4
@IBOutlet weak var phoneInput: UITextField!
5
6
...
7
8
@IBAction func login(_ sender: Any) {
9
// get the text input
10
let textInput = self.phoneInput.text ?? ""
11
12
func authCb(accessToken: String, error: Error?) -> Void{
13
guard let error = error else {
14
print("error logging in!")
15
return
16
}
17
18
// error handling
19
print("success!")
20
}
21
22
let cotter = Cotter(
23
apiSecretKey: "<API_SECRET_KEY>",
24
apiKeyID: "<API_KEY_ID>",
25
cotterURL: "https://www.cotter.app/api/v0",
26
userID: "[email protected]",
27
configuration: [:]
28
);
29
30
cotter.startPasswordlessLogin(
31
parentView: self,
32
input: textInput,
33
identifierField: "phone",
34
type: "PHONE",
35
directLogin: true,
36
cb: authCb
37
)
38
}
39
}
Copied!
To login and enter email or phone number in Cotter's window, simply set the directLogin to false and set the input to empty string
1
cotter.startPasswordlessLogin(
2
parentView: self,
3
input: "",
4
identifierField: "phone",
5
type: "PHONE",
6
directLogin: false,
7
cb: authCb
8
)
Copied!
To send code/link via SMS or WhatsApp, you'll need to add some balance to you project in the Dashboard.
Step 4: Receive Token
The token will be received in the callback function. The token will be in the form as the following:
1
"token": {
2
"identifier": "+12345678910",
3
"identifier_type": "PHONE",
4
"receiver": "<your API_KEY_ID>",
5
"expire_at": "1584687591",
6
"signature": "G8dOKR6qLj+GiB0pD2aggVVdYddFoyy..."
7
}
Copied!
The token contains the user's phone number, your API_KEY_ID in the receiver field, and a signature to ensure this is from Cotter. The token tells you that this identifier is verified.
You should include this JSON Object into your call to your backend for Login or Registration. Your backend should then verify that the signature of the token is valid.
Validating Cotter's Access Token
Checkout how to verify the OAuth Tokens from Cotter here:
🎉 You're done!
Securing your Project
Since you'll be using your API Key from a front-end website or mobile app, your
API_KEY_ID is exposed to anyone inspecting your code. Here are some ways to prevent abuse:Last modified 1yr ago