Skip to main content

General Information on the ADF Search Application API

The API provides programmatic access to the ADF Search Application resources and functionality. It follows RESTful API conventions.

OpenAPI Specification

We provide a definition of the ADF Search Application API as an OpenAPI document compliant with the OpenAPI Specification 2.0. The document is accessible at servername/basepath/api-docs. You can explore the ADF API specification in the Swagger UI accessible at servername/basepath/swagger-ui.html or import it into a third-party tool of your choice.

Authentication and Authorization

To use the ADF Search Application API, you need a PoolParty user account permitting API access to ADF Search Application. You also need to authenticate your requests using an OAuth 2.0 access token. For more information, refer to API Authentication and Authorization.

API Requests

To make an API request to the ADF Search Application, you need to combine the following:

  • an HTTP method – the ADF API employs the following methods following REST principles:

    • GET for requesting information about a resource

    • POST for creating a resource

    • DELETE for deleting a resource

    • PUT for modifying an existing resource

  • the URI of the resource consisting of the root URL (servername/basepath, referred to as {baseUrl} in the API Reference) and one or more path variables as specified in the API Reference

  • query parameters – some of the GET requests permit or require query parameters as specified in the API Reference

  • request body in JSON format – mandatory with PUT and POST requests as specified in the API Reference

  • HTTP request headers

    • Authorization – must include OAuth 2.0 access token as a bearer token. For more information on how to get an access token, refer to API Authentication and Authorization.

      Important

      Although the ADF Search Application comes with several API endpoints accessible without an access token, we recommend that you include the OAuth 2.0 access token in every request.

    • Content-Type – application/json is a mandatory content type for operations with a request body

API Responses

A call to the ADF Search Application API returns an HTTP status code and a JSON response body. You can find more information on the meaning of the individual status codes as well as response schemas and samples in the API Reference.

In this section: