PerfectApps API (Application Programming Interface) allows third party applications to pass data into PerfectApps or extract data from it. They can query and modify account-wide data programmatically and invisibly. The most common uses for the API are:
•creating a new app instance and populating fields with data
•updating existing app fields
•deleting an app instance
•reading data from an existing app instance.
Alternatively to the API, you can pass data between an app and a third party application or database using Connections, (see the Integration topics).
The PerfectApps API consists of a set of Web Services based on the SOAP/.Net 2.0 protocol.
REST API Web Services are also available for the Account API type.
PerfectApps has three different API types:
•Account API - Query and modify account-wide data. For SOAP this common service is found at the “.../api/api.asmx” URL. For REST the service is found at ".../REST/api/Customer/<method>"
•App API - Query and modify app-specific data. Each published app has a dedicated service to read data from and write data to PerfectApps app instances. This app-specific service is at the URL you receive from the app’s link dialog. Each app has its own service. For example: "/api/apps/rZtAg7gAggAAcgQM_My_App.asmx"
•Portal API - Query user-specific data such as lists of viewable apps or pending notifications. This enables developers to create their own web portal where users can log in and view apps, reports and notifications.
Jump to a related TOPIC |
Jump to a new SECTION |
