https://github.com/telexintegrations/barrzupdate
API integrated with Telex that retrieves a list of latest music releases across genres from the Spotify API
https://github.com/telexintegrations/barrzupdate
Last synced: over 1 year ago
JSON representation
API integrated with Telex that retrieves a list of latest music releases across genres from the Spotify API
- Host: GitHub
- URL: https://github.com/telexintegrations/barrzupdate
- Owner: telexintegrations
- Created: 2025-02-22T15:11:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-22T21:15:16.000Z (over 1 year ago)
- Last Synced: 2025-02-22T22:22:39.640Z (over 1 year ago)
- Language: C#
- Size: 11.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Spotify Telex Integration API Documentation
## Overview
This API retrieves the latest music releases across genres from Spotify and integrates with Telex, a notification system that calls this API and sends updates to a designated Telex channel.
## Prerequisites
- .NET 6 or later installed
- A Spotify API key
- Telex integration configured
## Setup
1. Clone the repository:
```sh
git clone
cd
```
2. Restore dependencies:
```sh
dotnet restore
```
3. Configure environment variables:
- `SPOTIFY_CLIENT_ID`: Your Spotify client ID
- `SPOTIFY_CLIENT_SECRET`: Your Spotify client secret
- `TELEX_WEBHOOK`: Your Telex webhook
4. Run the API:
```sh
dotnet run
```
## Base URL
```
https://baseURL
```
## Endpoints
### 1. API Health Check
**Endpoint:**
```
GET /
```
**Response:**
```json
{
"message": "API is active - {token}",
"status": 200
}
```
### 2. Get Telex Integration Config
**Endpoint:**
```
GET /integration.json
```
**Response:**
```json
{
"data":{}
}
```
### 3. Get Latest Music Releases
**Endpoint:**
```
GET /GetLatestBarrz
```
**Response:**
```json
[
"Artist1 - Song1",
"Artist2 - Song2",
"Artist3 - Song3"
]
```
**Status Code:** `200`
### 4. Receive Telex Message
**Endpoint:**
```
POST /tick
- sample url : https://hng12.bsite.net/tick
```
**Sample Request Body:**
```json
{
"channel_id": "01952b42-efee-711d-bf7e-314d1942b740",
"return_url": "https://ping.telex.im/v1/webhooks/01952b42-efee-711d-bf7e-314d1942b740",
"settings" : [
{
"label" : "interval",
"type" : "text",
"required" : true,
"default" : "0 8 * * 1-6"
}
]
}
```
**Response:**
```json
{
"status": "Accepted"
}
```
**Status Code:** `202`
## License
This project is open-source and available under the MIT License.
## Author
Developed by BahdMan.