PopoOpenPlatform Api icon

PopoOpenPlatform Api

POPO OpenPlatform API

Overview

This n8n node interacts with the POPO OpenPlatform API to retrieve detailed information about a user. Specifically, for the resource 用户 (User) and the operation 获取用户详情 ("Get User Details", corresponding to open-apis/corp/v1/employee), the node allows you to fetch comprehensive details about an employee by providing either their email address or job number.

Common Scenarios:

  • Automating HR workflows where you need to enrich records with up-to-date employee information.
  • Building integrations that require fetching user profiles based on identifiers like email or job number.
  • Synchronizing user data between POPO OpenPlatform and other systems.

Practical Example:
You can use this node in a workflow to look up an employee's full profile when only their email is known, then pass that data to another system for onboarding, reporting, or notification purposes.


Properties

Name Type Meaning
User Email String The email address of the user whose details you want to retrieve.
jobNumber String The job number (employee ID) of the user whose details you want to retrieve.

At least one of these properties should be provided to perform the lookup.


Output

The output will be a JSON object containing the user's details as returned by the POPO OpenPlatform API. The exact structure depends on the API response, but typically includes fields such as:

{
  "jobNumber": "12345",
  "email": "user@example.com",
  "name": "张三",
  "department": "技术部",
  "position": "开发工程师",
  // ...other user attributes
}

Note: The actual fields may vary depending on the API implementation and the user's data.


Dependencies

  • External Service: Requires access to the POPO OpenPlatform API.
  • API Credentials: You must configure valid credentials (popoOpenPlatformApi) in n8n for authentication.
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

Common Issues:

  • Missing or Invalid Credentials: If credentials are not set up correctly, the node will fail to authenticate.
  • Insufficient Input: If neither "User Email" nor "jobNumber" is provided, the API may return an error or no results.
  • User Not Found: If the provided identifiers do not match any user, the response will likely indicate that the user does not exist.

Error Messages & Resolutions:

  • "Authentication failed": Check your API credentials in n8n.
  • "User not found" or empty result: Verify the email or job number is correct and exists in the POPO system.
  • "Missing required parameter": Ensure at least one of "User Email" or "jobNumber" is filled in the node configuration.

Links and References


Discussion