0 Web (http) REST API

f4exb edytuje tę stronę 2018-06-12 13:19:17 +02:00

Since version 4 (v4.0.0) the Web (http) REST API is fully implemented and allows complete interaction with the SDRangel application. Only a few plugins (same as for the server instance) are not supported.

The documentation is available online when either the sdrangel or sdrangelsrv programs are fired up. You can control the network interface being listened to and the port with the appropriate options (see -h for help). With the default values it will be available at http://127.0.0.1:8091 The API also uses this address with the http://127.0.0.1:8091/sdrangel root URI.

The documentation home page has links to two flavors of documentation:

• A plain HTML (HTML2) based documentation that has some client coding snippets examples for various languages
• A Swagger UI instance that can directly interact with the API so that you can try it online with the live application

This API is based on version 2 of the Open API specification.

The Swagger source code of the API and a few examples of clients written in Python are available in this section of the repository: https://github.com/f4exb/sdrangel/tree/master/swagger/sdrangel

• Home
• Quick start
• Quick start legacy (v6)
  • Main Window
  • Spectrum
• Hardware requirements
• High DPI displays
• Compile in Linux
• Compile in Windows
• Compile in MacOS
• History and major releases
• Audio related
  • Notes on Pulseaudio setup
  • Audio management
  • Networking audio
  • WSJT X
  • Decoding Morse from audio
  • Text to speech
• Plugins
  • Channel plugins with special conditions
  • Channel Rx plugins
  • Channel Tx plugins
  • Channel MIMO plugins
  • Plugins for special devices
  • Device Rx plugins
  • Device Tx plugins
  • Device MIMO plugins
  • Feature plugins
  • Notes
    • SDRPlay RSP1 on Linux
    • Soapy Remote
    • SDRPlay and SoapySDR (obsolete)
• Advanced
  • Developers notes
• Server and API
  • SDRangel server
  • Web (http) REST API
  • Reverse API