mirror
/
podcast-namespace
kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Update Chapters.md

pull/210/head
Benjamin Bellamy 2021-03-11 19:47:11 +01:00 zatwierdzone przez GitHub
rodzic d08f99d194
commit d3e352474d
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 6 dodań i 5 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

11
API/Chapters.md
Wyświetl plik

@ -36,16 +36,16 @@ And we think that this is pretty cool.
This API uses REST. This API uses REST.
It involves 2 parties: It involves 2 parties:
- a poscast hosting service - a Poscast Hosting service.
- a chapter provider service - a Chapters Provider service.
### Endpoints ### Endpoints
This API has only one endpoint (so far), hosted at the Chapter provider. This API has only one endpoint (so far), hosted at the Chapters Provider.
#### AddNewEpisode #### AddNewEpisode
- `POST /AddNewEpisode` - `POST /AddNewEpisode`
This adds a new Episode to the chapter provider. This adds a new Episode to the chapter provider.
The endpoint URL may be defined by the chapter provider. The podcast hosting service must provide a way to specify this endpoint URL as a parameter. The endpoint URL may be defined by the chapter provider. The Podcast Hosting service must provide a way to specify this endpoint URL as a parameter.
Parameters: Parameters:
- `rss`: RSS feed URL - `rss`: RSS feed URL
@ -58,7 +58,8 @@ Response:
- `episodeUrl`: Url for episode on dashboard - `episodeUrl`: Url for episode on dashboard
### Authentication ### Authentication
The chapter provider will provide a couple `apiKey` and `apiSecret` which will be displayed on the user dashboard. Thir API will use the mechanism already used by the [PodcastIndex.org API](https://podcastindex-org.github.io/docs-api/#auth).
The Chapters Provider will provide a couple `apiKey` and `apiSecret` which will be displayed on the user dashboard.
Fields: Fields:
- `User-Agent`: Mandatory - `User-Agent`: Mandatory
Please identify the system/product you are using to make this request. Please identify the system/product you are using to make this request.