Client App Registration

As the first step, the PPW customer should register the client app with PPW before the app can access the PPW API Services.

The client app can be registered with PPW through the “Admin / Client Apps” section in PPW Web. The registration form will request the customer the following information:

• App Name: App’s name.

• Scopes: The allowed OAuth scopes for the app.

The scopes decide which PPW API services the client app can access.

The scopes will be in this form:

SERVICE-r
SERVICE-rw

So, if the PPW API has two services called “property” and “workorder”, the scopes will be:

property-r
property-rw
workorder-r
workorder-rw

The scope that ends with -r will grant the app “read” access to the corresponding service; the one that ends with -rw will grant the app “read/write” access to the corresponding service.

Once, the customer successfully registers the client app, they’ll be able to download the API credentials. The credentials will be a JSON object with the following information:

{
   "grant_type": "client_credentials",
    "client_id": "ORG_ID-HEX-app-name",
    "client_secret": "715713424bf66aea949452...",
    "scope": "property-rw workorder-r",
    "api_url": "https://ppw.web/svc"
}

PPW will not have a copy of the client_secret. So, if the PPW customer loses their client_secret, they’ll have to regenerate the secret for their app it from PPW Web.