PeopleSoft API Essential Guide

What type of API does PeopleSoft provide?

REST API

PeopleSoft primarily uses REST APIs for integration purposes. Some key points about PeopleSoft's REST API support:

• PeopleTools has supported REST-style interactions since version 8.52 (released in October 2011).
• REST APIs in PeopleSoft use the RESTListeningConnector.
• PeopleSoft REST APIs follow standard REST principles like using HTTP verbs (GET, POST, PUT, DELETE) and having descriptive URLs.
• Starting with PeopleTools 8.55.11, there is improved support for JSON parsing in REST APIs.

SOAP API

While not explicitly mentioned for recent versions, PeopleSoft historically supported SOAP APIs:

• The search results mention "old SOAP or RPC model" when comparing to REST, implying SOAP was previously used.
• SOAP APIs typically relied only on POST requests and used a single URL endpoint, unlike the more flexible REST approach.

GraphQL API

PeopleSoft does not support GraphQL APIs:

• The search results explicitly state: "GraphQL will likely never be supported in PeopleSoft".

Key Considerations

1. REST is now the primary API paradigm used in PeopleSoft for integration purposes.
2. PeopleSoft has been evolving its REST API support over different PeopleTools versions.
3. While SOAP was likely supported in older versions, the focus has shifted to REST APIs.
4. PeopleSoft delivers specific REST APIs for different functional areas and applications.

In summary, PeopleSoft primarily uses REST APIs for modern integrations, with some historical support for SOAP, but does not support GraphQL.

Does the PeopleSoft API have webhooks?

Based on the search results provided, it appears that the official PeopleSoft API does not have webhooks. The search results primarily discuss webhooks in the context of Oracle Content Management, not PeopleSoft. However, I can provide some general information about webhooks in Oracle Content Management, which may be useful for understanding how webhooks typically work in enterprise systems:

Webhooks in Oracle Content Management

Oracle Content Management offers both incoming and outgoing webhooks:

1. Incoming Webhooks:

   • Allow Oracle Content Management to receive notifications from external services based on various events.
   • Use token-based authentication for validating incoming requests.

2. Outgoing Webhooks:

   • Automatically push notifications for events such as asset publishing, asset lifecycle changes, site publishing, prerendering, and scheduled jobs.

Types of Events for Outgoing Webhooks

Oracle Content Management allows subscribing to various events through outgoing webhooks, including:

1. Asset Lifecycle Events:

   • Events related to content items and taxonomies in a repository.

2. Asset Publishing Events:

   • Notifications about assets published to or unpublished from a channel.

3. Site Publishing Events:

   • Events related to site publishing, such as published, status changes, and unpublished.

4. Prerender Events:

   • Notifications about the need to render and cache a site detail page.

5. Scheduled Jobs Events:

   • Events related to publishing jobs scheduled in a repository, including created, updated, canceled, started, and completed.

Key Points

• Webhooks can be configured through the Oracle Content Management web interface or using REST API endpoints.
• Administrators can create different types of webhooks based on their needs (e.g., Asset Lifecycle Webhook, Asset Publishing Webhook, Site Publishing Webhook).
• Webhook payloads can be configured to provide either brief or detailed information about the events.
• Authentication options for webhook endpoints include None, Basic Auth, and Secure Header.

While this information is specific to Oracle Content Management and not PeopleSoft, it provides an overview of how webhooks are typically implemented in enterprise systems. If you need specific information about PeopleSoft's API capabilities, you may want to consult PeopleSoft's official documentation or contact their support team directly.

Rate Limits and other limitations

Based on the search results provided, I don't have specific information about the API rate limits for the PeopleSoft API. The search results don't contain direct information about PeopleSoft API rate limits. However, I can provide some general information about API rate limits and best practices:

General API Rate Limiting Concepts

1. API rate limits are typically implemented to protect the API service and ensure fair usage among all users.

2. Rate limits are often defined on a per-key or per-user basis, with a fixed window strategy (e.g., X requests per minute).

3. When rate limits are exceeded, the API usually returns an error code (e.g., 429 for "Too Many Requests").

Best Practices for API Rate Limiting

1. Monitor your API usage: Keep track of your request counts to avoid hitting rate limits unexpectedly.

2. Implement proper error handling: Be prepared to handle rate limit errors in your code.

3. Use caching: Implement caching strategies to reduce the number of API calls you need to make.

4. Optimize API calls: Ensure you're only requesting the data you need and batching requests when possible.

Checking and Managing Rate Limits

1. Check API documentation: Always refer to the official API documentation for specific rate limit information.

2. Use response headers: Many APIs include rate limit information in response headers, such as remaining requests and reset times.

3. Contact support: If you need higher rate limits, reach out to the API provider's support team or account manager.

Key Points to Consider

• PeopleSoft-specific information: Without access to official PeopleSoft API documentation, I cannot provide specific rate limit details for their API.

• Variability: API rate limits can vary widely between different providers and even different endpoints within the same API.

• Authentication: Rate limits are often tied to authentication methods, so ensure you're using the correct authentication for your needs.

In conclusion, while I don't have specific information about PeopleSoft API rate limits, it's important to check the official PeopleSoft API documentation or contact their support team for accurate and up-to-date information on rate limits and usage restrictions.

Latest API Version

Based on the search results provided, here are the key points regarding the most recent version of the PeopleSoft API:

Most Recent Version

The most recent major version of PeopleSoft is PeopleSoft 9.2, which was released in 2013 [4]. This remains the current version, with Oracle providing ongoing updates and enhancements through the PeopleSoft Update Manager (PUM) rather than releasing entirely new versions [4].

Key Features of PeopleSoft 9.2

• Improved user experience with more intuitive navigation [4]
• Global free text search function with over 120 indices for easier feature discovery [4]
• Contextually relevant actions to guide users through common activities [4]
• PeopleSoft Update Manager (PUM) for customized and streamlined updates [4]
• Mobile accessibility for certain functions like placing and approving orders [4]

Ongoing Updates

While PeopleSoft 9.2 remains the latest major version, Oracle continues to provide regular updates and enhancements:

• Updates are delivered through the PeopleSoft Update Manager (PUM) [4]
• This allows for more frequent, targeted updates without the need for major version releases
• Updates include new features, regulatory updates, and patches [4]

API Considerations

While the search results don't provide specific information about the PeopleSoft API version, it's important to note that:

• The API capabilities would be tied to the overall PeopleSoft version (9.2)
• API updates and enhancements are likely delivered through the PUM along with other software updates
• PeopleSoft offers various API types, including Component Interfaces, Application Messaging, and RESTful Web Services [3]

It's worth noting that while PeopleSoft 9.2 is from 2013, the continuous update model through PUM means that the current functionality, including API capabilities, is likely much more advanced than the initial 9.2 release.

How to get a PeopleSoft developer account and API Keys?

To get a developer account for PeopleSoft to create an API integration, you'll need to follow these steps:

1. Obtain PeopleSoft Access

First, you need to have access to a PeopleSoft environment. This typically requires:

• A license for PeopleSoft software from Oracle
• Access to the PeopleSoft application and PeopleTools

If you're an external developer, you'll need to work with an organization that has a PeopleSoft license.

2. Gain Access to Integration Tools

PeopleSoft uses Integration Broker for creating and managing web services and APIs. You'll need:

• Access to PeopleTools, which includes Integration Broker
• Appropriate security permissions within PeopleSoft to work with Integration Broker

3. Understand Available Integration Methods

PeopleSoft offers several ways to create API integrations:

• Integration Broker: For creating web services and REST APIs
• Component Interfaces: For exposing PeopleSoft components as services
• PeopleSoft API Repository: For discovering available classes, methods, and properties

4. Set Up Development Environment

To develop integrations, you'll need:

• PeopleTools installed on your development machine
• Access to PeopleSoft Application Designer
• Appropriate security roles and permissions

5. Learn PeopleSoft Integration Technologies

Familiarize yourself with:

• PeopleCode (PeopleSoft's programming language)
• Integration Broker configuration
• Web services and REST API concepts in PeopleSoft

6. Create and Configure Integrations

Use Integration Broker to:

• Define services and service operations
• Create handlers for processing integrations
• Expose PeopleSoft functionality as web services or REST APIs

What can you do with the PeopleSoft API?

Based on the search results provided, here is a list of data models that can be interacted with using the PeopleSoft API, along with what is possible for each:

PeopleSoft API Repository

• Enables discovery of internally available classes, methods, and properties [1]
• Divided into namespaces containing related classes (e.g., "PeopleSoft," "ComponentInterface," "Trees," "BusinessInterlinks") [1]
• Allows determination of available methods and properties for any object returned by a PeopleSoft API call [1]
• Provides information about property types (string, number, Boolean, etc.) and usage (input, output, or both) [1]

Data Model

• Allows mapping of PeopleSoft records to OPA entities [2]
• Supports different entity types:
  • Global Input: Contains input attributes at the global level of an ASSESS request message [2]
  • Global Output: Contains output attributes at the global level of an ASSESS response message [2]
  • Input: Contains input attributes for ASSESS request messages [2]
  • Input/Output: Contains both input and output attributes [2]
  • Output: Contains output attributes for ASSESS response messages [2]
• Enables configuration of entities, including setting attributes, relationships, and filters [2]

REST API Endpoints

• Primarily used in Human Resources (HR) and Financial Supply Chain Management (FSCM) modules [3]
• Allows exchange of employee details, job postings, financial transactions, and procurement information [3]
• Supports real-time data exchange and immediate response to business events [3]
• Uses standard HTTP methods for universal accessibility and ease of use [3]

Component Interfaces (CI)

• Provides access to and manipulation of PeopleSoft components programmatically [3]
• Encapsulates business logic and ensures data integrity [3]

Application Messaging

• Enables asynchronous communication using messages and queues between PeopleSoft and external systems [3]

Integration Models

• Direct Database Connections:
  • Allows raw data extraction and integration with systems requiring direct database access [3]
  • Requires robust security measures and performance optimization [3]
• Web Services (REST/SOAP):
  • Supports real-time data exchange and transaction processing [3]
  • Adheres to application-level security and business logic [3]

API Methods

• GET: Used for generating real-time reports or dashboards [3]
• POST: Ideal for data entry scenarios, such as through self-service portals [3]
• PUT: Commonly used for updating personal information in employee self-service scenarios [3]
• DELETE: Used for maintaining data integrity and removing obsolete information [3]

System and Process APIs (MuleSoft Integration)

• System APIs: Expose data across business applications or data stores [5]
• Process APIs: Consume and orchestrate data exposed by System APIs, representing common business processes [5]
  • Can be used for querying data, executing actions, and serving as an abstraction layer during system migrations [5]

This list covers the main data models and interaction possibilities with the PeopleSoft API based on the provided search results. Each model offers different capabilities for integration, data manipulation, and process automation within the PeopleSoft ecosystem.