Skip to Main Content
ProductRapids API HubOne seamless connected experience that supports every type of developer as they build, use, and share APIs.Build APIsAPI HubAPI Hub for BusinessAPI Hub for EnterpriseEnterpriseInternal API HubPartner API HubSecurityCustomersVertical SolutionsResourcesEBooks & GuidesWhitepapers & ReportsDatasheets & One-Pagers‎ ‎ ‎ ‎‎ ‎VideosWebinarsDocsCoursesLearnBlogPricingCompanyCareersPress/NewsEventsBlogContactSign upSign inSign upProductBuild APIsAPI HubAPI Hub for BusinessAPI Hub for EnterpriseEnterpriseInternal API HubPartner API HubSecurityCustomersVertical SolutionsResourcesEBooks & GuidesWhitepapers & ReportsDatasheets & One-Pagers‎ ‎ ‎ ‎‎ ‎VideosWebinarsDocsCoursesLearnBlogPricingCompanyCareersPress/NewsEventsBlogContactSign inSign up

Rapid Video:

How to use Rapid's API Hub for Teams


Rapid's API Hub for Teams

A place for you to publish, share, and collaborate on internal APIs and microservices.

This video will show you how to create an Organization on Rapid's API Hub for Teams and get started in just a few moments.


Video transcript:

Welcome to Rapid API! Today we are going to look at Rapid API for teams, how you can get started inviting users or creating teams, and how to customize your organization homepage which is what you're seeing here. We can customize this branding as well as set up different collections of APIs that will be displayed. Essentially, we will be creating an API hub where you can share internal APIs, external API subscriptions, govern usage, view analytics, and more. This is gonna be a quick start overview video since there's a lot to go over. We also have timestamps in the description and links to the Rapid API per team's Doc's in case there's just one specific topic that you're looking for. Let's get started by creating a new organization. You can see I'm logged into my Rapid API account here so I can just click on create organization up in a top navigation bar. We can fill out the required information, so I will add an org named 5 seats or 5 users is the default. If you stick with five or fewer seats, your Rapid API for team subscription will be completely free. Every additional seat after the first five will be ten dollars per month per seat. If your subscription is paid, you will also need to provide payment information. I'm going to stick with five so we can skip that step, but keep in mind you can always add or remove seats later as your needs change. I'll click confirm and continue. Now that we have created our organization, we will be taken to the organization dashboard. This is where you will be able to manage the org, add users, create teams, and more. One thing to note is the checklist that appears in the top. If you get stuck setting up the organization, you can click the information icon and it will help guide you through the task. These tasks will be checked off when you complete them. We're actually going to walk through all of these in the video so I will close this for now but definitely keep this in mind as a great tool when you're setting up your organization. Let's add our first user. To do so, I am just gonna type an email into this field and assign their account privileges. You can see we have the choice between admin and developer so I will assign them to be a developer. The big difference between an admin and a developer account is that admins are the only ones that have access to this dashboard where you can edit the organization. Developers will not be able to see this dashboard but they will be able to see the organization homepage which is what we showed at the beginning of this video. Next, we can select what team the developer will belong to. For now, we just have our default team available so I will leave it at that. We will get into adding and editing teams a bit later. I'll click invite this user and they will show up as a pending account down here in our manage users section. Once they accept the emailed invitation to Rapid API for teams, the account will no longer be pending. The manage users section will also allow you to change the team or privileges of the account. You can just edit the desired user and change the details as you wish. Notice here that you can change a user from developer to admin or from admin to developer. Adding users one by one is fine if you only have a few seats available but for larger groups, say of 10 or 20 or more, it's going to be a lot faster for you to do a bulk user import. We will post a separate video about this and it's also covered in the Rapid API for teams documentation. Let's move on to the manage teams tab. We only have one team right now. Everyone will have this default team to begin with. To add our own, click the Create new team button. We can add a team name, a description, and even a logo or image here if you want, so let's save this and it will appear on our team list. Just like with users, we can change or update this team at any time by clicking the edit button. Now that we've gone over some basic setup on the organization dashboard, let's take a look at the organization homepage. Here we have an empty org home page. If you remember the example at the beginning of the video, we had quite a few API collections and custom branding, so let's take a look at some of the steps that we can take to make this homepage a bit more filled out and a bit more useful. To add a private API, I'm gonna go to the provider dashboard. You will notice a drop-down in the top left corner here that lets me select between my personal account and any teams my account is associated with. I'm going to select the Rebel Alliance team here. We aren't gonna get into the details of adding an API in this video, but we will be posting a separate video about that, and you can also refer to our documentation linked in the video description if you need help adding an API. Let's navigate back to the org home page, and now our API appears. Anybody on the Rebel Alliance team can see this collection. As a note, admins will also see all of the teams and all of the team APIs. Let's take a look at adding another API, but this time we're going to add it to the Jedi Order team. I'm going to speed this process up here just so you don't have to sit through it all, but again to clarify, these APIs are published privately by default, meaning they are not visible to anybody outside of the organization. As you can see here on the org home page, we will now have two APIs, one is under the Rebel Alliance team and the other is under the Jedi Order team. So, for example, if my account was only on the Jedi Order team, I would not see the one that's on the Rebel Alliance team unless I was also on that team. If you change your mind or want the API to be available to multiple teams, we can update this easily, so I'll go back to the provider dashboard where we first uploaded this API, select the definition page for the API you want to share, navigate to the settings tab, and scroll down to the invite developers section. You can choose to invite a user, an organization, or a team. For our demo, let's select team, and we will now be able to choose from the teams in the org. Likewise, it's quite easy to remove a team's access to a shared API by clicking the X and saving your changes. Finally, let's look at how we can subscribe to public APIs. I have picked an API from the rapid API marketplace, and you can see I am on the pricing page for the API. Now, in order to subscribe, I'm gonna select the team I want from this drop-down, and this is just like the context drop-down on the provider dashboard. In the developer dashboard, it allows you to switch what account you are making the subscription under. I will select Rebel Alliance and go ahead and subscribe to the API. Back on our organization homepage, we will see the API subscription here. As you can see, these APIs are categorized already based on the team, and our public API subscriptions are also separated out. But what if we wanted to make our own collection or own grouping of APIs? It's pretty easy to do that, so we can just go back to the organization dashboard and select the organization homepage tab. On the left you will see we are here under API collection and I will select new API collection, we can name our collection, assign an image, add a description, and add api's to the collection. You will note that we can select from both internal private API s and external API subscriptions. For our demo, I will just add all three of these api's. Admins can update or add API collections at any time and these collections will be shared across the entire organization. You can also drag and drop the order of the collections and that will be reflected on the organization home page as well. While we're here, let's take a look at the custom branding tab. This is where admins can set up the branded elements for the org home page. So quickly, I will go ahead and add a logo, a banner, a title, and a tagline. So let's see what our org home page looks like now that we've made these changes. You can see our logo, our banner, our title, and our tagline have all been updated. We also have our custom collection here showing up above the other team API collections. So once we add a few additional api's and subscribe to a few more public api's, this is our final result. Hopefully, this gives you an idea of how you can build a custom API hub in just a few moments. We went over a lot of information pretty quickly in this video, so please let us know if you have any questions. Below you can also check out the full Rapid API for teams documentation, which is a bit more in-depth and hopefully addresses any topics we might have skimmed over here.

Rapid API logo - white

Follow Us

© Rapid 2023Terms of ServicePrivacy