NetDNA REST Web Services Python Client

Prerequisites

sudo pip install requests

sudo pip install certifi

Installation

sudo pip install netdnarws

Usage

from netdnarws import NetDNA

api = NetDNA("myalias", "consumer_key", "consumer_secret")

# Get Account Info
api.get("/account.json")

# Create Pull Zone
api.post("/zones/pull.json", {'name': 'mypullzone', 'url': 'http://yourorigin.com', 'compress': '1'})

# Update Pull Zone
api.put("/zones/pull.json/12345", {'url': 'http://neworigin.com'})

# Purge All Cache
api.delete("/zones/pull.json/12345/cache")

# Purge File
api.delete("/zones/pull.json/77573/cache", data={'file': '/my-file.png'})

Methods

It has support for GET, POST, PUT and DELETE OAuth signed requests.

We now have a shortcut for Purge Calls!

zone_id = 12345

# Purge Zone
api.purge(zone_id)

# Purge File
api.purge(zone_id, '/some_file')

# Purge Files
api.purge(zone_id, ['/some_file', '/another_file'])

Every request can take an optional debug parameter.

api.get("/account.json", debug=True)
# Will output
# Making GET request to http://rws.netdna.com/myalias/account.json
#{... API Returned Stuff ...}

Every request can also take an optional debug_json parameter if you don't like the exception based errors.
api.get('/account.json', debug_json=True)

For more information about what optional parameters this methods accept you should check out @kennethreitz library Requests.

Initialization

For applications that don't require user authentication, you can use the default initialization as the example above.

For applications that require user authentication, you can initialize the API as follows.

api = NetDNA("myalias", "consumer_key", "consumer_secret",
             token="user_token", token_secret="user_token_secret")

You can also send the optional parameter header_auth, which takes a boolean to send the OAuth header in the body or URLEncoded.