Skip to content

Portal, API and hosted pages in interaction

The tebio platform can be used in three ways: via the tebio Business Portal, via the API and via Hosted Pages.

These three access routes fulfill different tasks, but access the same central platform data and platform processes.

  • The tebio Business Portal is the work interface for business users.
  • The API is the technical interface for integrations and automation.
  • Hosted Pages are interfaces provided for customer or partner processes in your own branding.

Together, the portal, API and hosted pages form a flexible platform architecture: Internal teams work operationally in the portal, external systems integrate via the API, and customers or sales partners interact via provided pages.

AccessTarget groupTypical usage
tebio business portalBusiness User, Operations, Finance, Customer Care and Product ManagementManual management, configuration, testing and operational processing
APIDevelopers, technical teams, backend systems and integration partnersSystem integration, data transfer, process control and automation
Hosted PagesCustomers, sales partners, affiliate partners and external usersOrders, self-care / customer portal, sales partner portal and affiliate pages

All three accesses can be used individually or in combination, depending on the business model.

The tebio Business Portal is the web-based user interface of the tebio platform.

Business users use the portal to carry out central tasks directly without having to develop their own software. The portal is particularly suitable for operational activities, configurations and manual testing processes.

Typical tasks in the tebio business portal are:

  • Create and edit customers
  • Create, change, pause or cancel subscriptions
  • Configure products, options and prices
  • Enter or check orders
  • View and manage invoices
  • Track payments, credits and refunds
  • Process helpdesk tickets
  • Manage sales partners
  • Maintain settings and configurations
  • View event history and documents

The portal is particularly relevant for teams that need to control, check or correct business processes.

The API is the technical interface to the tebio platform.

External systems can use the API to transfer data to tebio, trigger platform functions or retrieve information from tebio. The API is suitable for companies that want to integrate tebio into existing system landscapes or automate recurring processes.

Typical API use cases are:

  • Create or update customers from an external CRM system
  • Create subscriptions from your own product backend
  • Transfer orders from an external shop
  • Submit usage data for usage-based billing
  • Retrieve billing or payment information
  • Report status changes to external systems
  • Integrate self-service processes into your own customer portal

The API is particularly relevant if processes are not to be carried out manually in the portal, but are controlled from other systems.

The detailed technical description of the endpoints, parameters, authentication and response formats can be found in the separate API reference.

Hosted pages are pages provided by tebio in your company’s branding.

They enable customer or partner-side processes without companies necessarily having to develop their own front end. Hosted pages access configured platform processes and can be integrated into your own business model.

Typical areas of application for hosted pages are:

  • Order pages
  • Self-care / customer portal
  • Sales partner portal
  • Affiliate Pages
  • Customer registration
  • Updating customer information or payment methods
  • Display documents or invoices
  • Capturing consent

Hosted pages are particularly suitable if customers, sales partners or affiliate partners need to interact directly with processes on the tebio platform.

Portal, API and Hosted Pages work with the same core platform objects.

These include, for example:

  • customers
  • Products
  • Options
  • Subscriptions
  • Orders
  • Bills
  • Payments
  • Documents
  • Events
  • Sales partner
  • Tenants, settings and configurations

If a customer places an order via a hosted page, this order can then be viewed and processed in the tebio business portal.

If an external system creates a subscription via the API, this subscription can also be managed in the portal.

When a business user makes a change in the portal, this change can become relevant to external systems via events or webhooks.

This creates a common process space in which manual, automated and customer or partner processes are brought together.

A common process combines all three approaches:

  1. A company configures products, options, prices and hosted pages in the tebio business portal.
  2. A customer orders a product via a hosted page.
  3. The order creates a subscription or another subsequent process in the tebio platform.
  4. Business users check or edit the process in the tebio business portal.
  5. External systems are informed of relevant changes via API or webhooks.
  6. Invoices, payments, documents and events are managed centrally in tebio.

This flow shows that portal, API and hosted pages are not separate systems. They are different gateways to the same platform data and platform processes.

Example: Order via hosted page with API connection

Section titled “Example: Order via hosted page with API connection”

A company offers a subscription product through a hosted page.

The customer opens the order page, enters his details, chooses a payment method and completes the order. tebio uses this to create the relevant platform objects, for example customer, order and subscription.

Internal teams can then check the process in the tebio business portal. At the same time, an external system can be informed via webhooks and, if necessary, retrieve further data via the API.

This means that customer-related processes can be made available quickly via hosted pages, while internal teams work in the portal and external systems remain technically connected.

If you want to decide which access is suitable for your use case, read the article When do I use portal, API or hosted pages?.

Other relevant topics: