Get Started Guide: Creating Your Partner App in Sprout

Welcome to the Sprout Partner Ecosystem!  This guide walks you through the process of registering your partner app, setting up your environment, and making your first API call with Sprout.

Before You Begin

To start your integration journey with Sprout, please reach out to our Alliance Management Team <[email protected]>. They will guide you through partnership discussions and help finalize the agreement.

Once you’ve officially partnered with Sprout, follow the steps below:

1. Partner Registration

Step 1: Register on the Developer Portal

Access the partner portal and complete your registration:

Portal (Sandbox):
https://developers-sb.sprout.ph/signup

Step 2: Notify Integration Team

After registering, please notify the point of contact for the alliance management team so we can proceed with provisioning your environment and credentials.

2. Provisioning & Configuration (Handled by Sprout)

After your registration, Sprout will handle the following:

  • Partner Credentials: We’ll generate and share your clientId and clientSecret.

  • API Access Configuration: Based on your app’s needs, we’ll configure what data and scopes you can access.

  • Sandbox Environment: A safe environment to test your integration.

You’ll receive an email from us once everything is ready.

3. Available API Endpoints

Currently, only Employee Services are available for partner integrations.

Base URL (Sandbox Gateway):
https://developers-api-sb.sprout.ph/e/

4. Integration Demos

4.1 Direct API Integration (Using Postman)

Step 1: Get an Access Token

Use your provided clientId and clientSecret to request an access token.

  • Token Endpoint: This uses the client_credentials grant type.

Result: You’ll receive an access_token which you'll use in subsequent API requests.

Refer to the API Documentation for the complete request format and required headers.

Step 2: Call the API

Once you have the access_token, use it as a Bearer token to authenticate your API requests.

  • Authorization: Include Authorization: Bearer your-access-token in your headers.

Usage: This token allows you to make authenticated requests to any available endpoint.

Check the API Documentation for endpoint details, parameter options, and expected responses.

4.2 One-Way SSO (Sprout to Partner App)
1. JWT Token will be provided from Sprout, structure depending on the partner's token endpoint. See sample JWT token below (decoded using https://jwt.io/)

2. For each Sprout client to be onboarded, a public key (signature) will be provided as well from the Sprout Team. This could be used to verify that the JWT token came from Sprout.

3. To access other Sprout endpoints, Partners should use the client credentials (clientID and secret) provided.

Partner App Submission Guide

To list your app in the Ecosystem Platform under My Apps or the App Drawer, please submit the following details. This ensures your app is properly displayed and accessible to users from the dashboard.

Required Information

Please prepare the following assets and details before submission:

1. App Name

  • The official name of your application.

  • This will be displayed in the dashboard and searchable by users.

2. Landing Page or Redirection Link

  • A direct URL that users will be redirected to upon clicking your app from the dashboard.

  • It must be HTTPS.

3. App Logo or Image

  • This image will be displayed in the App Drawer.

  • Specifications:

    • Format: PNG or SVG

    • Size: 512 x 512 pixels

    • Transparent background preferred

    • Keep the design readable on both light and dark backgrounds

4. Metadata 

Provide the following to improve discoverability and user experience:

  • App Description: Short summary of what the app does (max 250 characters)

  • Category: (e.g., HR, Finance, Productivity)

  • Tags: Keywords users may search for

  • Support Link: URL to your help center or support contact

Documentation Link: URL to technical or user-facing docs (if applicable)

Important Notes

  • Once submitted, your app will undergo a brief validation process.

  • Ensure the landing page is accessible and secure.

  • If you plan to display user-specific data, ensure proper authorization flows are handled from your app’s end.

How to Submit

Please send all the required assets and information via email to your Sprout alliance management POC:

Help Center

If you encounter any issues or have questions, don’t hesitate to reach out to our team at [email protected] or via your Alliance Manager contact.