Prophy API introduction

Overview

The Prophy API will help you integrate your system with the Prophy platform, enabling Prophy Referee Finder capabilities for your users. This can be done with the following services:

• Manuscript upload: Upload a manuscript and immediately receive referee candidates. Manuscript upload API →
• Authors groups: Create and manage pools of experts. Authors groups API →
• Custom fields: Retrieve custom field definitions to use them in the integration. Custom fields API →
• User login: Login users into Prophy platform, granting them necessary access rights. No need to register users with confirmation via email. User login →
• Webhooks: Receive webhook notifications about events in Prophy. Webhooks →

You can implement these components independently based on your specific needs. The most common starting point is the Manuscript upload API, which provides immediate value by returning referee candidates.

Integration dashboard

The Integrations dashboard is a control panel for managing your Prophy API integration. Users with the Integrations admin permission can access this dashboard to:

• View and manage API keys.
• Configure settings for API requests.
• Set Webhook endpoints.
• See Webhook logs.

Need Help?

If you encounter any issues or have questions about the API:

• Verify the API Key and organization code. For example, if you are a manuscript manager system operator, remember that each of your clients who use integration with Prophy has its own credentials.
• Check the example requests provided in the corresponding API endpoint section.
• Contact your Prophy account manager for assistance.