Torrent Suite™ Software API User Guide

The Torrent Suite™ Software API User Guide describes the technology behind API and how to leverage the technology using the REST interface.

• Purpose
• General Architecture
  • Programming model
• Technology
  • REST
  • Django
  • PostgreSQL
• Links to References
  • Technology
  • Tools
• Get started
  • Request resource data
  • Get a single resource
  • Check for errors
  • Next steps

Topics in this list provide background and conceptual information on parameters, requests, responses, and endpoints:

• Parameters
  • Required parameter
  • Optional parameters
• Request and Response Headers
  • Request header
  • Response header
• HTTP Response Codes
• Endpoint Metadata

The following topics provide more detail about implementing and maintaining REST applications:

• API Implementation
  • URI Structure
  • Authentication
  • Responses
  • Error Messages
  • Data Formats
• Work with Django
  • Key
  • Fields
  • Filter Qualifiers
• Debug API Errors
  • HTTP status codes
  • Debug backend errors
  • Debug HTML or JavaScript
  • Event logging
• Tools
  • cURL
  • REST Clients
  • REST Programming Libraries

The API is built on the Django Framework, which implements a Model View Controller (MVC) architecture and supports the REST communication model. Using the Torrent Suite™ Software REST API, client applications operate on resources modelled in the back-end PostgreSQL database. Database, file, and system resources are addressable using a Universal Resource Identifier (URI), and can be created, read, modified, searched, and sorted using parameterized REST methods.

This document provides a semantic description of the API, which complements the API syntax presented in the Torrent Server REST API v1 Resources.