Partners

Partner Management

The portal administrator can create a partner.

Partner signup Configuration

1. Portal administrators can enable or disable Partner features on the site.

2. Navigate to Home >> Site Administration >> Partner Signup Configuration.

3. Click on the Disabled button to enable the Partner Signup feature on the site

4. Once the Partner feature is enabled, all Partner features will be activated on the site.

Adding a Partner

To add a partner as a portal administrator, follow these steps:

1. Log in with portal admin credentials.

2. Navigate to Home >> Manage Partners.

3. Click on Add Partner.

   • Title is a mandatory field.

   • Description, Tags, and Icon fields are optional.

4. Select the Enabled checkbox to enable the Partner.

5. Click on Save.

Deleting a Partner

The Delete Partner option is currently disabled due to dependencies on APIs, Gateway connections, and API products. These dependencies will be addressed in the next phase.

Enabling or Disabling a Partner

To enable or disable a partner:

1. Log in as the portal administrator.

2. Navigate to Home >> Manage Partners.

3. Select the Edit Partner link under the Operations column.

4. In the Partner Status field, select Disabled to disable or Enabled to enable the partner.

5. Click on Save.

6. Note: When a Partner is disabled, its members will lose access to Partner-related features and can only view the portal like other consumers.

Partner Member Management

Assuming you are logged in as a portal admin, follow these instructions:

Adding an Internal User

1. In the Operations column dropdown for the respective partner, click Add Internal User.

2. In the Users field, add the required users.

3. Click on Submit to add the users to the partner.

4. Note: Portal admins can add themselves as a Partner Admin or Partner Member to any Partner group.

Viewing Members

1. Click on View Members in the Operations dropdown column for the respective partner.

2. You will be redirected to the partner's Members List page, displaying usernames, roles, updated and joined dates.

3. The Operations column includes options for Edit Member and Delete Member.

Inviting an External User

Both the portal admin and the partner admin can invite external users:

1. Click on Invite External User in the Operations dropdown column for the respective partner.

2. Enter the user's email and select the roles to assign.

3. Click on Save to send the invitation. The user will receive an invite link via email.

• The user will receive an invite link via email and can follow further steps from there.

Managing Invitations

1. In the Operations dropdown column, select Manage Invitation for the respective partner.

2. The portal admin can view all invitations sent to that partner.

3. To revoke an invitation, click Remove Invitation. Once removed, the user can no longer sign up using the invite link.

Editing Members

1. In the Operations dropdown for the respective partner, click View Members

2. Click on Edit Member

3. Update the necessary roles and click Save to apply the changes

Remove Members

• In the Operations dropdown for the respective partner, click View Members

• Click on Remove Member

• Confirm removal by clicking Delete

Partner Management and Viewing Members

Partner admins can manage partner members.

1. Navigate to Home >> Partners.

2. The Partners page displays partners in tile format, showing titles, descriptions, and tags.

3. Partner admins can see options for Manage Members and Browse APIs

Inviting New or Existing Members

1. In the Manage Members page, click Invite Members.

2. Enter the email and select roles for the user.

   • Existing users receive an invite link.

   • New users receive a signup link.

3. Click Submit to send the invite.

4. The user can accept or reject the invitation through the invite email.

Adding or Removing Roles

1. In Manage Members, partner admins will see options to Set as Partner Admin or Remove Member in the Operations column.

2. Set as Partner Admin assigns the partner admin role, while Delete Member removes the user from the partner.

View Pending Invitations

• In Manage Members, the Pending Invitations tab displays all invitations with invite details and invitee information.

Import APIs and API products

Partner admins can import APIs and API products following similar steps as the portal admin:

1. Navigate to Home >> API Administration >> Import APIs and API Products.

2. Click on the gateway and the Credentials tab to view Gateway connections.

3. Partner admins can create, edit, or delete a gateway connection and import APIs or API products. Using the same steps as the portal admin, partner admins can add a Gateway connection and import the respective APIs and API products.

4. Under the Import APIs tab, partner admins can import all APIs associated with the selected gateway connections.

5. Under the Import API Products tab, partner admins can import all API products from the respective gateway connections.

   For specific steps on configuring a gateway connection and importing APIs and API products, see the Import APIs section.

Managing APIs

1. Navigate to Home >> API Administration >> APIs to see all the APIs imported by the partner admin.

2. The APIs page is accessible only to partner admins and displays all imported and manually created APIs.

3. The page offers options to search for APIs by title, status, and language.

4. To create a new API manually, click Create API. Manually created APIs will be tagged to the partner.

5. In the Operations column, select Edit to modify the API or Delete to remove it.

   Refer to the Create APIs section for detailed steps on creating APIs.

Managing API Products

1. Navigate to Home >> API Administration >> API Products to access all API products managed by partner admins.

2. The API Products link is available only to partner admins and provides full management options for imported API products.

3. To edit an API product, click the Edit option in the Operations column.

4. To delete an API product, click the Delete option in the Operations column.

Managing Apps

When a user is a member of a partner, they have the option to create an app as Internal or Private.

• Internal apps: Accessible to all members of the partner.

• Private apps: Accessible only to the user who created them.

To create an app:

1. Navigate to Home >> Apps >> Create App.

2. Refer to the Create App section for further details on creating apps.

To view a list of all apps:

1. Navigate to Home >> Apps >> All Apps.

2. In the Operations column on the All Apps page, you can click Delete to remove an app.

Partner Member

Apps

Partner members can browse APIs from the Home >> Partners page.

Partner members have the option to create both Private and Internal apps using the Home >> Apps >> Create Apps link.

To view all created apps:

1. Navigate to Home >> Apps >> All Apps

2. To delete an app, click the Delete link in the Operations column on the All Apps page

View Partner Analytics

• Navigate to Manage Partners

• Click the Partner Analytics tab to view analytics