TPF XML API

From The PODFather Wiki
Jump to: navigation, search

This wiki contains documentation about the PODFather XML API.

Contents

Concept

The PODFather API allows you to automatically create and fetch details for jobs, create runs and download completed PODs using HTTP requests.

PODFather service methods are accessed using HTTP calls to an endpoint on our public-facing API server, with some requests requiring an XML payload in the request body.

All requests must be authenticated with your account ID and API key. If you have not received an API key, please contact your account manager.

API Details

All API methods use the same endpoint: https://app.thepodfather.eu/api.php

This endpoint accepts both HTTP GET and POST requests, although POST will be required for the majority of methods as the XML payload should be sent as the HTTP POST body.

All requests require authentication with your account ID and API key, which should be sent as GET parameters or as part of an x-www-form-urlencoded POST body.

Example GET Request

GET /api.php?podfather_id=exampleid&podfather_key=examplekey&action=podfather.jobs.getDetails&version=1.2&job_id=123 HTTP/1.1
Host: app.thepodfather.eu
Cache-Control: no-cache

Example POST Request

POST /api.php HTTP/1.1
Host: app.thepodfather.eu
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

podfather_id=exampleid&podfather_key=examplekey&action=podfather.jobs.getDetails&version=1.2&job_id=123

As you can see from the examples above, the API Method is specified as a string in the "action" key within each request.

Detail about the expected request / response body is provided on each individual method page below.

API Methods

Additional documentation

External links

Personal tools