Congegni/sintonia
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

change "Airtime" to "Libretime" except where it refers to code.

Browse source
This commit is contained in:
greenjon 2019-01-22 22:14:59 -08:00
parent ccdd447ddc
commit 126288af6e
9 changed files with 44 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/manual/airtime-api-authentication/index.md
View file

@ -1,19 +1,19 @@
The Airtime API enables many types of information about the broadcast schedule and configuration to be retrieved from the Airtime server. Other than the live-info and week-info data fetched by website widgets (see the chapter *Exporting the schedule*), all API requests must be authenticated using the secret API key stored in the file */etc/airtime/api\_client.cfg* on the Airtime server. This key is autogenerated during Airtime installation and should be unique for each server.
The Libretime API enables many types of information about the broadcast schedule and configuration to be retrieved from the Libretime server. Other than the live-info and week-info data fetched by website widgets (see the chapter *Exporting the schedule*), all API requests must be authenticated using the secret API key stored in the file */etc/airtime/api\_client.cfg* on the Libretime server. This key is autogenerated during Libretime installation and should be unique for each server.
If you intend to use the Airtime API across a public network, for security reasons it is highly recommended that all API requests are sent over encrypted https: and that the web server is configured to accept requests to the api/ directory from specific host names or IP addresses only.
If you intend to use the Libretime API across a public network, for security reasons it is highly recommended that all API requests are sent over encrypted https: and that the web server is configured to accept requests to the api/ directory from specific host names or IP addresses only.
The format of API requests is:
https://airtime.example.com/api/api-action/format/json/api_key/XXXXXX
https://libretime.example.com/api/api-action/format/json/api_key/XXXXXX
where api-action is the type of request and XXXXXX is the secret API key. Available actions include:
- on-air-light - return true if the station is on air
- status - get the status of Airtime components and resource usage
- version - returns the version of Airtime installed
- status - get the status of Libretime components and resource usage
- version - returns the version of Libretime installed
- get-files-without-silan-value - list files for which silence detection has not yet been performed
- get-stream-setting - gets the settings of Airtime output streams
- get-stream-parameters - gets the parameters of Airtime output streams
- get-stream-setting - gets the settings of Libretime output streams
- get-stream-parameters - gets the parameters of Libretime output streams
For example, using the action *get-stream-setting* returns the following output for the first configured stream:
@ -41,9 +41,9 @@ Some API requests require the directory ID number to be specified as *dir\_id* i
For example, using a request such as:
http://airtime.example.com/api/list-all-files/format/json/api_key/XXXXXX/dir_id/1/
http://libretime.example.com/api/list-all-files/format/json/api_key/XXXXXX/dir_id/1/
returns the full path to each media file in the Airtime storage directory:
returns the full path to each media file in the Libretime storage directory:
{"files":[
"imported\/1\/Mark Ronson feat. Saigon\/Here Comes the Fuzz\/7-Diduntdidunt-unknown.flac",