Integrating with a REST API by using OpenAPI Specification
Simplify your integration with a REST API by connecting to an OpenAPI Specification. By using the complete, accurate schema that is published in your OpenAPI Specification, you can easily create and update data sources in Pega Platform.
- In the navigation pane of App Studio, click Data.
- On the Data objects and integrations landing page, click a data page.
- On the Data pages tab, in the data page for which you want to configure data sources, click .
- On the Connection details page, in the
System field, select a system of record.
- Create new - Create a new system to connect to an external database by using a REST connection. Then, enter a name and a description for the new system.
- Use an existing system - Select the name of an existing system to connect to an external database by using a REST connection.
- In the Connection field, select Use openAPI.
- In the OpenAPI source field, choose the source of the
YAML file to which you want to connect.
- Specification path – In the OpenAPI
specification path field, enter the location of the
.yamlfile. - Upload a YAML file – Click Choose
File, and then select the
.yamlfile and click Open.
- Specification path – In the OpenAPI
specification path field, enter the location of the
- Click Next.
- On the OpenAPI connection method page, in the
Tag field, select the tag that you use to group
methods related to a specific category, for example, Credit card
applications.
Result: The system displays a list of GET and POST operations available in the .yamlfile. - Select the method that you want to use to connect to your OpenAPI
specification.
Note: To use the POST method as a source for your data page, the content type for the request body must be application/x-www-form-urlencoded. The content type for the response body must be application/json.
If you are using the POST method to update a save plan, the supported content type for the request and response body is application/json. For more information, see Configuring a save plan for a data page in App Studio.
- Click Next to advance to the Data mapping page.
Previous topic Data mapping limitations Next topic Preparing your data for production