Consumers
Consumers
Consumers are the developers who sign in to your API Portal, the teams they work in, and the optional companies that group email domains. You manage all of them under Consumers in the dashboard.
Consumers are the people and groups on the other side of your API Portal. A consumer is an individual developer who signs in. A team is the group that owns subscriptions and credentials. A company is an optional grouping of email domains. You manage all three from the Consumers group in the dashboard.
What is a consumer in Apiable?
A consumer is a developer who signs in to your API Portal to find, subscribe to, and call your API products. In the dashboard, consumers are listed under API Consumers. Each consumer has a profile and an approval status.
The consumer-side experience, where developers sign up, subscribe, and create credentials, is covered in Partner & Developer onboarding. This section covers what you, the provider, see and manage in the dashboard. For where the API Portal fits in Apiable, see API Portal on the platform.
How do consumers, teams, and companies relate?
A consumer works inside a team, and every subscription belongs to a team. A consumer can belong to several teams. A company is optional: it groups email domains, routes sign-in for those domains, and a team can be linked to one company.
| Object | What it is | What it holds |
|---|---|---|
| Consumer | An individual developer who signs in to your API Portal. | A profile and an approval status. |
| Team | The group a consumer works in. Every subscription belongs to a team. | Members, subscriptions and their credentials, prepaid credits, and its own email domains for domain joining. |
| Company | An optional grouping of email domains. Off until you turn on company mode. | Email domains and the identity provider that sign-in for those domains routes to. |
A company's domains route sign-in. Domain-based team joining uses the team's own domains. See Teams and companies for both.
Where do you manage consumers?
In the dashboard, under the Consumers group in the sidebar. It always holds API Consumers, Requests, Subscriptions and Teams. Companies appears when company mode is on, and Pipeline appears when your Apiable plan includes the sandbox and partner pipeline.
| Page | What you do there |
|---|---|
| API Consumers | Browse developers, see their approval status, and open a consumer's profile. |
| Requests | Approve or decline pending registrations, subscriptions, and access (scope) requests. The sidebar entry shows how many are waiting. |
| Subscriptions | See every subscription across teams, with its status and pipeline phase. |
| Teams | Browse and create teams, and manage members, invitations, subscriptions, credits, and domain settings. |
| Companies | Map email domains to a company and an identity provider. Shown only when company mode is on. |
| Pipeline | Review partners' sandbox submissions and move them to production. Shown only when your Apiable plan includes the sandbox and partner pipeline. |
Where to start
Consumer accounts
The API Consumers list, a consumer's profile tabs, and approval status.
Teams and companies
Team members, invitations, domain joining, team credits, and company mode.
Subscriptions
Subscription statuses, tabs, plan changes, cancelling, and billing.
Requests and approvals
Approve or decline registration, subscription, and access requests in one place.