Home

wpm_api_client

This client is a set of Python bindings for all of the available endpoints in Neustar WPM's REST API.

Installing the client

The client is available pre-packaged via-pip.

pip install wpm_api_client

You can manually install from source using setup.py.

Creating a connection

Using the Client class, we'll store the connection as a state. In this instance (and for all examples in this documentation), 'connection' is defined as 'c'.

import wpm_api
c = wpm_api.Client(api_key, api_secret)

Your api_key and api_secret are located within your WPM user account. Each individual user has their own unique key and secret. This can be found in the UI under Manage Account->Users. Selecting any given username will present a License Key (api_key) and License Password (api_secret).

Client structure

There are 8 classes available, each a different service within the WPM product.

• Alert
• File
• Instant Test
• Load
• Maintenance
• Monitor
• Rum
• Script

A service's class is invoked as a method of our base connection. In turn, each class contains a set of sub-methods representing actions.

service = c.service(service_id)

Arguments:

service_id - A semi-optional argument, only required for methods modifying a particular item within the service.