Policies API Guide

This guide provides an overview of and basic scenarios for using the Policies API.

Prerequisites

This guide assumes that you have familiarity with basic Digital.ai App Management API tasks such as authenticating and retrieving app data. You should also have experience using and managing policies in the Admin Portal. Before using this guide, it would be helpful to review the following topics:

• About Policies
• Authentication
• List All Applications

tip

Reference Documentation

You should have the Policies API Documentation available to reference while using this guide.

Using this Guide

This guide covers the following topics:

• About the Policies API provides an overview of the API and describes basic concepts.
• Using the Policies API provides some usage scenarios and examples.

The scenarios in this guide do not cover every possible workflow, and are not intended as complete tutorials. Rather, they provide common examples that should guide developers when using the Policies API to create their own integrations.

Examples

The examples in this guide use cURL, an open-source command line tool, to send HTTPS requests. These examples work on computers running Mac OS, Linux, or Cygwin (a collection of tools for running Linux apps on Windows). If you want to use cURL during your development and testing process, it is available at curl.haxx.se.

tip

cURL is the easiest way to show correct usage in examples, but we recommend using Postman to interact with the Digital.ai App Management API.

All the examples show URLs for the Digital.ai App Management NA (Europe) production environment. There are different base URLs for the EU and NA (North America) environments. If you copy examples from this guide, be sure to use the correct URL.