When do I use portal, API or hosted pages?
The tebio platform offers three different access paths with the tebio Business Portal, the API and the Hosted Pages.
This article serves as a decision-making aid to select the appropriate access or the best combination for various use cases and integration scenarios.
Short decision
Section titled “Short decision”| situation | Recommended access |
|---|---|
| An internal user is supposed to edit a process manually | Business portal |
| A customer should order or manage data themselves | Hosted Pages |
| An external system should transfer data automatically | API |
| Tebio should use its own front end in the background | API |
| A process should be made available quickly without any in-house development | Hosted Pages |
| A support or finance team should check processes | Business portal |
When do I use the tebio business portal?
Section titled “When do I use the tebio business portal?”The tebio business portal is particularly suitable if tasks need to be processed manually, professionally or operationally.
Use the portal, for example, if you:
- Want to manage customers or subscriptions individually
- want to configure products and options
- Want to check or understand invoices
- Want to track payments, credits or refunds
- Edit helpdesk tickets
- Want to maintain settings and templates
- want to manage sales partners
- Want to view event histories or documents
The portal is the right entry point for business users, operations, customer care, finance and product management.
When do I use the API?
Section titled “When do I use the API?”The API is particularly suitable if processes need to be automated or connected to other systems.
Typical API use cases are:
- Create or update customers from a CRM system
- Transfer orders to tebio from your own checkout
- Synchronize subscriptions from an external system
- Submit usage data for usage-based billing
- Transfer invoices and payment status to an ERP system
- Retrieve documents
- Evaluate webhook events
- Build your own portals or apps on tebio data
The API is the right gateway for developers, integration partners and technical teams.
When do I use hosted pages?
Section titled “When do I use hosted pages?”Hosted pages are particularly suitable if customers, sales partners or affiliate partners need to carry out processes themselves without having to develop their own front end.
Use Hosted Pages, for example, if you:
- Want to provide order pages with your own branding
- want to use a self-care / customer portal without your own frontend
- Want to digitize sales partner processes
- Want to provide affiliate pages
- Want to collect payment methods, consents or customer data
Hosted pages are the right access if customers, sales partners or affiliate partners should interact with tebio processes, but the interface should be made available.
Typical combination patterns
Section titled “Typical combination patterns”Often the best solution is a combination of approaches.
Portal first, API later
Section titled “Portal first, API later”Many companies start with the tebio business portal to manually manage products, customers, subscriptions and invoices. If processes later grow or need to be more automated, the API can be supplemented.
This pattern is suitable for companies that want to start quickly and build integrations gradually.
API for automation, portal for control
Section titled “API for automation, portal for control”In this pattern, customers, orders, or subscriptions are automatically created via the API. Business users use the portal to check processes, process exceptions or resolve support cases.
This pattern is suitable for companies with existing CRM, ERP, shop or backend systems.
Hosted pages for customers, portal for back office
Section titled “Hosted pages for customers, portal for back office”In this pattern, customers use hosted pages for orders, self-service, or data changes. The back office manages the resulting processes in the tebio business portal.
This pattern is suitable for companies that want to digitize customer-facing processes without completely developing their own front end.
Combine hosted pages and API
Section titled “Combine hosted pages and API”Hosted pages can map customer or partner processes, while the API informs external systems about results or synchronizes additional data.
This pattern is suitable when companies need interfaces that can be used quickly, but still want deep technical integration into existing systems.
Partner processes with hosted pages and portal
Section titled “Partner processes with hosted pages and portal”Sales partners can be integrated into processes via partner sites, affiliate pages or sales partner portals. Business users manage partners, customers, subscriptions and commission processes in the portal.
This pattern is suitable for reseller, affiliate or multi-level sales models.
Decision support
Section titled “Decision support”| Question | Recommended access |
|---|---|
| Should a business user edit the process manually? | tebio business portal |
| Should an external system trigger the process automatically? | API |
| Should a customer or sales partner carry out the process themselves? | Hosted Pages |
| Should a process take place in your own frontend? | API |
| Do you want to quickly use a provided interface in your own branding? | Hosted Pages |
| Should a process be checked, corrected or traced? | tebio business portal |
| Should an event or status be reported to external systems? | Webhook or API |
Role of webhooks
Section titled “Role of webhooks”Webhooks complement the API by automatically informing external systems of events.
While the API is actively being called, a webhook sends a notification to a preconfigured URL whenever a relevant event occurs.
Typical events are:
- Customer was created or updated
- Subscription created, changed or canceled
- Order entered or processed
- Invoice created
- Payment has been processed
- Document generated
- Helpdesk ticket updated
Webhooks are particularly useful when external systems need to react promptly to changes in the tebio platform.
Best practices
Section titled “Best practices”Establish clear system responsibility
Section titled “Establish clear system responsibility”Determine early on which system is leading for which data. For example, a CRM system may be the leader for customer data, while tebio is the leader for subscriptions, invoices and payments.
Do not plan portal and API against each other
Section titled “Do not plan portal and API against each other”The portal and the API are not alternatives in the strict sense. Often the best solution is a combination: the API automates standard processes, the portal supports control, exceptions and manual processing.
Use hosted pages for standardized external processes
Section titled “Use hosted pages for standardized external processes”If customers or sales partners need to carry out processes themselves, hosted pages are often faster and more robust than a completely separate frontend. It makes sense to have your own front end if you want user guidance, design or product logic to be completely individually controlled.
Consider events and webhooks early
Section titled “Consider events and webhooks early”Webhooks should be planned early in integrations. They help inform external systems of changes and avoid manual synchronization.
Common misunderstandings
Section titled “Common misunderstandings”Is the tebio business portal just an admin frontend?
Section titled “Is the tebio business portal just an admin frontend?”No. The tebio business portal is the central work interface for business users. It is not only used for administration, but also for the operational processing of customers, subscriptions, orders, invoices, payments, helpdesk tickets and sales partners.
Do I have to use the API to start with tebio?
Section titled “Do I have to use the API to start with tebio?”No. Many functions can be used directly in the tebio business portal. The API is particularly relevant when processes need to be automated or external systems need to be integrated.
Do hosted pages replace your own website or frontend?
Section titled “Do hosted pages replace your own website or frontend?”Not complete. Hosted pages map certain processes such as orders, self-care / customer portal or partner processes. A public marketing website, individual product pages or completely custom user navigation can still be implemented outside of tebio.
Can portal, API and hosted pages be used in parallel?
Section titled “Can portal, API and hosted pages be used in parallel?”Yes. This is actually a common use case. The three accesses can be combined and work with the same central platform data.