Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyouteki/gotps
Go OTP Server for communicating with gibotp android application
https://github.com/hyouteki/gotps
api-rest firebase go server
Last synced: 3 days ago
JSON representation
Go OTP Server for communicating with gibotp android application
- Host: GitHub
- URL: https://github.com/hyouteki/gotps
- Owner: hyouteki
- License: gpl-3.0
- Created: 2024-10-30T10:31:19.000Z (6 days ago)
- Default Branch: master
- Last Pushed: 2024-10-30T11:18:39.000Z (6 days ago)
- Last Synced: 2024-10-30T12:25:00.630Z (6 days ago)
- Topics: api-rest, firebase, go, server
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Go OTP Server for integration with the [gibotp](https://github.com/hyouteki/gibotp) Android application.
> This server registers devices and requests OTPs from specified services by sending notifications to the registered device.
# API documentation
Server exposes two endpoints.
## 1. Receive OTP
- **URL**: `/receive_otp`
- **Method**: `POST`
- **Description**: Receives an OTP sent from the client and validates its presence in the request. If valid, a success message is returned.
### Request Body
| Field | Type | Description | Required |
|-------|--------|------------------------|----------|
| otp | String | The OTP to be verified | Yes |
### Example
```bash
curl -X POST http://0.0.0.0:3000/receive_otp -H "Content-Type: application/json" -d '{"otp":"123456"}'
```
```json
{
"otp": "123456"
}
```
### Responses
- `200 OK`: The OTP was received successfully.
- `400 Bad Request`: No OTP was provided in the request.
## 2. Register Device
- **URL**: `/register_device`
- **Method**: `POST`
- **Description**: Registers a device using the provided UUID and FCMToken. If successful, the server stores the device's FCM token using the UUID as a key.
### Request Body
| Field | Type | Description | Required |
|-----------|--------|---------------------------------------------------|----------|
| uuid | String | The unique identifier for the device | Yes |
| fcm_token | String | The Firebase Cloud Messaging token for the device | Yes |
### Example
```bash
curl -X POST http://0.0.0.0:3000/register_device -H "Content-Type: application/json" -d '{"uuid":"device-123", "fcm_token":"abcd1234fcmToken"}'
```
```json
{
"uuid": "device-123",
"fcm_token": "abcd1234fcmToken"
}
```
### Responses
- `200 OK`: The device was registered successfully.
- `400 Bad Request`: The request is missing required fields or has invalid data.
- `500 Internal Server Error`: Unable to process the request. Possible reasons: Error occurred while inserting data into the database for user registration.
# Getting Started
1. Ensure you have Go installed and set up on your system.
2. Run the server using the command `go run main.go`.