ContentDepot
ContentDepot hosts a range of API’s that allow clients to manage, discover, and obtain content. The API spans many parts of the ContentDepot functionality…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
ContentDepot hosts a range of API’s that allow clients to manage, discover, and obtain content. The API spans many parts of the ContentDepot functionality including MetaPub (a.k.a. metadata distribution) and content management.
MetaPub
MetaPub collects, normalizes and distributes publicly available program, episode, and piece metadata through the public radio system. Backed by ContentDepot and its data model, MetaPub allows producers to supply metadata through various methods:
- MetaPub Agents that collect producer metadata by "crawling" existing public feeds (e.g. C24, BBC) or the producer's production system (e.g. ATC, ME, TED Radio Hour).
- Manually enter metadata in the ContentDepot Portal on each program and episode.
- Publish/push the metadata to the MetaPub upload API and execute an ingest job.
MetaPub then distributes this data to stations through an electronic program guide (EPG model) for display on various listener devices such as smart phones, tablets, web streams, HD radios, RDBS enabled FM radios, and more. The EPG format is based on the RadioDNS specifications.
RadioDNS
The RadioDNS Service and Programme Information Specification (ETSI TS 102 818 v3.4.1) defines three primary documents: Service Information, Program Information, and Group Information. These documents, along with the core RadioDNS Hybrid Lookup for Radio Services Specification (ETSI TS 103 270 v1.4.1), define a system where an end listener device can dynamically discover program metadata and fetch the metadata via Internet Protocol (IP) requests. MetaPub's use of RadioDNS differs slightly in that MetaPub (a.k.a PRSS) acts as the "service provider" while the stations and related middleware act as the end devices. While this is not the primary use case of RadioDNS, the flexibility in the specification, service definitions, and DNS resolution allows this model to be easily represented. MetaPub provides both _National Metadata_ and _Station Metadata_.
It is strongly recommended that the related RadioDNS specifications be read for implementation details, definitions, and required XML schemas.
ContentDepot Drive
ContentDepot Drive (CD Drive) provides a private, per customer file storage solution similar to other cloud storage solutions such as Google Drive, Box, and Dropbox. The CD Drive is used to stage content uploads such as metadata files, images, or segment audio before associating the content with specific programs or episodes.
CD Drive content can be referenced using a URI by some operations such as synchronizing metadata. There are two possible CD Drive URI formats supported: ID and hierarchical path. The ID reference takes the form cddrive:id:{value} where value is the integer ID of the file or folder being referenced. The hierarchical path reference takes the form cddrive://{path} where path is the full, UNIX style path to the file or folder starting with '/'. For example, two CD Drive URIs pointing to the same file may be cddrive:id:12345 and cddrive:///show1/episode2/metadata.xml. More information about URIs can be found at Wikipedia.
Authentication
The API currently uses OAuth 2.0. All operations require cd:full access where the client access is only limited by the permissions of the ContentDepot user after authentication. Limiting access scope per client is not currently supported.
Endpoints 36
RadioDNS
- GETGet the group information document.
/radiodns/spi/3.1/GI.xmlThe group information (GI) document allows programs to be put into groups such as serials, series, shows, or general themes and provide additional metadata… - GETGet the service information document.
/radiodns/spi/3.1/SI.xmlThe service information (SI) document holds a definition of services provided by the service provider (e.g. MetaPub), including any relevant metadata and… - GETGet the program information document.
/radiodns/spi/3.1/id/:fqdn/:sid/:date_PI.xmlThe program information (PI) document holds the linear and the on-demand schedule of programs for a service over a 24 hour period. This information provides…
CD Drive
- POSTUpload a file.
/api/v2/cddrive/files/contentUpload a file to the customer's private CD Drive. - GETGet file information.
/api/v2/cddrive/files/:file-idGet the information about a file in the customer's private CD Drive. - DELETEDelete a file.
/api/v2/cddrive/files/:file-idDelete a file from the customer's private CD Drive. - GETUNDER DEVELOPMENT - Download a file.
/api/v2/cddrive/files/:file-id/contentDownload a file from the customer's private CD Drive. - POSTCreate a folder.
/api/v2/cddrive/foldersCreate a new folder in the customer's private CD Drive. - GETUNDER DEVELOPMENT - Get folder information.
/api/v2/cddrive/folders/:folder-idGet the information about a folder in the customer's private CD Drive. - DELETEUNDER DEVELOPMENT - Delete a folder.
/api/v2/cddrive/folders/:folder-id?recursive=trueDelete a file from the customer's private CD Drive. - GETGet the items in the folder.
/api/v2/cddrive/folders/:folder-id/items?offset=0&limit=20Get the information about a folder in the customer's private CD Drive.
Broadcast Services
- GETGets broadcast services matching the given criteria.
/api/v2/broadcastservices?pageStart=0&pageSize=500&orderById=asc - GETReturns the broadcast service matching the given ID.
/api/v2/broadcastservices/:id
Spot Insertions
- GETReturns the spot insertions matching the query parameters.
/api/v2/spotinsertions?pageStart=0&pageSize=500&orderById=asc - POSTCreates a new spot insertion.
/api/v2/spotinsertions - GETReturns the spot insertion matching the given ID.
/api/v2/spotinsertions/:id - DELETEDeletes the spot insertion with the given ID.
/api/v2/spotinsertions/:id
Programs
- GETOptimized free-text search for programs using various filters.
/api/v2/programs/search?keywords=string&pageStart=0&pageSize=500 - GETReturns the program matching the given ID.
/api/v2/programs/:id
Episodes
- GETGets episodes matching the given criteria.
/api/v2/episodes?id=0&beginAirDateAfter=2024-01-01T00:00:00Z&endAirDateBefore=2024-01-01T00:00:00Z&programId=0&pageStart=0&pageSize=500&orderById=asc - GETReturns the episode matching the given ID.
/api/v2/episodes/:id
Segments
- GETReturns the segments matching the query parameters.
/api/v2/segments?episodeId=0&segmentNumber=0&pageStart=0&pageSize=500&orderById=asc - POSTCreates a new segment.
/api/v2/segments - GETReturns the segment matching the given ID.
/api/v2/segments/:id - DELETEDeletes the segment with the given ID.
/api/v2/segments/:id - GETUNDER DEVELOPMENT - Returns the audio content segment matching the given ID.
/api/v2/segments/:id/content
Pieces
- GETReturns the pieces matching the query parameters.
/api/v2/pieces?episodeId=0 - POSTCreate a new piece.
/api/v2/pieces - GETReturns the piece matching the given ID.
/api/v2/pieces/:id - DELETEDeletes the piece with the given ID.
/api/v2/pieces/:id
MetaPub
- POSTCreate a batch operation on EPG information.
/api/v2/metapub/program-information/batchDeprecated. Create a batch to process the metadata of one or more electronic program guide (EPG) programs using metadata that has been uploaded to the… - GETGet an EPG batch operation.
/api/v2/metapub/program-information/batch/:batch-idDeprecated. Gets the batch information which can be used to check the status of the operation or retrieve more details if the batch fails.
Spots
- GETReturns the spots matching the query parameters.
/api/v2/spots?pageStart=0&pageSize=500&orderById=asc - POSTCreates a new spot.
/api/v2/spots - GETReturns the spot matching the given ID.
/api/v2/spots/:id - DELETEDeletes the spot with the given ID.
/api/v2/spots/:id
API details
- Authentication
- OAuth 2.0 (authorization code, implicit flows) with 1 scope
- Operations
- 36 operations on 26 pathsGET 23POST 7DELETE 6
2 marked deprecated - Main resources
- CD Drive 8Segments 5Pieces 4Spot Insertions 4Spots 4RadioDNS 3Broadcast Services 2Episodes 2MetaPub 2Programs 2
- Response formats
application/jsonapplication/xmlapplication/octet-stream- Description format
- OpenAPI 3.0.3, API version
2.0.0 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ContentDepot in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ContentDepot collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code, implicit flows) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get the group information document.” (GET /radiodns/spi/3.1/GI.xml), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ContentDepot?
ContentDepot hosts a range of API’s that allow clients to manage, discover, and obtain content. The API spans many parts of the ContentDepot functionality… It is listed under Media & content and has 36 endpoints.
Who publishes the ContentDepot?
It is listed from Prss's public API description (an OpenAPI document), not published by Prss on Swastik Codes. Anyone who controls prss.org can claim the profile by adding a DNS TXT record.
How do I authenticate with the ContentDepot?
With OAuth 2.0 (authorization code, implicit flows) with 1 scope.
How many endpoints does the ContentDepot have?
36 operations on 26 paths (23 GET, 7 POST, 6 DELETE). The largest groups are CD Drive, Segments, Pieces, Spot Insertions.
Is forking the ContentDepot free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.