API Admin Management

Invite others to be API Admins for your API and manage the API Admin group.

Table of Contents

  1. What are the components of the Admin page?
  2. How do I invite people to be administrators for my API?
  3. How do I invite non-members to be administrators of my API?
  4. How do I respond to an API administrator invitation?
  5. How do I cancel an API administrator invitation?
  6. How do I remove an API administrator from my API?

What are the components of the Admin page?

The APIs section includes an Admins page that allows you to invite others to be administrators for your API. API administrators can then be viewed and managed in a summary listing.

Invite Administrators

The Invite More function allows you to invite additional users to be administrators for your API.

View Administrators

When an administrator invitation is submitted, the username, email address, and invitation status of the invitee (Email Sent, Approved, or Rejected) is added to the Admins Summary.

Manage Administrators

API Administrators can remove an Administrator from the listing.

Back to top

How do I invite people to be administrators for my API?

The API > Admins page includes an administrator invitation function that allows you to invite people to be administrators for your API.

To invite someone to be an API Admin:
  1. Navigate to My APIs > API Name > Admins. The Admins page displays.
  2. Click Invite More. The Invite Administrators page displays.
  3. In the Email text box, enter the email address of individuals you would like to invite to your development team. Separate multiple email addresses with commas.
  4. In the Add a Brief Message text box, specify the invitation text you would like to send to your invitees.
  5. After completing your entries, click Invite. The invitation email will be sent to the invitee.
  6. After the email invitation is sent, the platform will post an administrator invitation to the member's Dashboard. The invited member can then log into the platform to accept or decline the administrator invitation.

Note: When you create an API, you are the administrator. Your administrator privilege is automatically approved and is posted to the Admins Summary page. You can then invite additional administrators using the Invite More function. Invitees that are not platform members must sign up before accepting the team invitation.

Back to top

How do I invite non-members to be administrators of my API?

You can invite non-members to be administrator of an API, but in order for the invitee to accept the invitation, they must be platform members. See Basics for sign up information.

Back to top

How do I respond to an API administrator invitation?

If you receive an invitation via email to be an administrator of an API you can accept or reject the invitation.

To accept an API administrator invitation:
  1. Click the link in the API administrator invitation email, log into the platform, and go to your Dashboard page.
  2. Choose your API administrator invitation in the newsfeed.
  3. To accept the API administrator invitation, click Accept. The Accept this invitation text box displays. Enter a comment (if applicable) and click Confirm. The status changes to Invitation Accepted.
  4. To view administrators for the API, click My APIs > Admins. The Admins page displays. Your username, email address, and Accepted team status displays. You can also view other members of the development team.
To decline an API administrator invitation:
  1. Click the link in the API administrator invitation email, log into the platform, and go to your Dashboard page.
  2. Choose your API administrator invitation in the newsfeed.
  3. To decline an API administrator invitation, click Decline. The Decline this invitation text box displays. Enter a comment (if applicable) and click Confirm. The status changes to Invitation Declined.

Back to top

How do I cancel an API administrator invitation?

Once an invitation is sent to an individual you would like to be an API administrator, the invitation itself cannot be revoked. A platform member can choose to accept or decline the invitation. If they choose to accept the invitation, you can remove the API administrator from your API by clicking Remove. See How do I remove an API administrator from my API?

Back to top

How do I remove an API administrator from my API?

Any API administrator can remove other administrators from the API.

To remove someone from the API admin team:
  1. Navigate to My APIs > API Name > Admins. The Admins page displays.
  2. To remove an API administrator from an API, choose the line item of the API administrator and click Remove.

Back to top