FabriXAPI User Guide

# Introduction of Provider Admin Portal

You need to generate your API Portal on FabriXAPI before using the Provider Admin Portal. Please refer to Register as an API Provider and Generate API Portals to generate your API Portal.

  1. To enter the Provider Admin Portal, you can log in to FabriXAPI Provider Admin Portal (opens new window)

  2. After entering the Provider Admin Portal, there are 3 main things you can perform:

  • Click on the API Portal card : Navigate to the management dashboard of a specific API Portal to configure different settings.

  • Click on the "link" icon button : Navigate to the API Portal (i.e. API user’s view of your API Portal).

  • Click “Generate Portal” button : Navigate to the Generate API Portal form to generate a new API Portal. For more information, please refer to Generate API Portals.

# Get Started

  • List the missions that can help you learn the basics of the Provider Admin Portal

# API Performance

  • Analytics

    • View the performance analytics of APIs you added on Provider Admin Portal, e.g. Number of API Calls by Other Developers, Error Rate and Latency of API
    • The data can be sorted by APIs and date, and it will be presented in a graph for easier reading

  • Logs

    • List the detailed logs of the API call record
    • It can be sorted by API, Developer, Response Status and Date

# My APIs

  • My APIs

    • View and edit all APIs you added on API Portal for details
    • APIs can be sorted by Name, customized Groups, Category and Visibility

# Subscriptions

  • Subscription Contract

    • List all purchase records of all APIs
    • It can be filtered by API, Purchase ID, Developer and Payment Status

  • Subscription Approvals

    • List all Subscription Requests from developers
    • Subscription Requests can be approved or rejected

  • Invoice

    • View all subscription invoice

  • Billing Record

    • View billing records from all of your subscribers

# Developers

  • List all active and invited developers

  • Invite developer to API or a specific API Plan

  • View Developer Details

  • Terminate or Stop Subscription Renewal of a Developer

# Appearance

  • Display Information

    • Edit basic information of your portal, e.g. Display Name, Public Contact and Provider Guides

  • Design & Branding

    • Customize your API Portal with text, images & theme colours

  • Themes

    • Customize your API Portal with 5 provided themes

  • Landing Page Setting

    • Customize your portal landing page with text and images

  • Header Setting

    • Customize the portal header with logo and URLs

  • Footer Setting

    • Customize the portal footer with logo and colour

# Admin Setting

  • Access Control

    • Edit Portal Permission to decide who can view your API Portal

  • Monetization Setup

    • Link your portal to your payment collection accounts to unlock Monetization feature

  • Event Notification

    • Connect FabriXAPI with other systems by using events and webhooks

    • View Event Logs

  • Admin API Credential

    • Create, regenerate and delete Key

    • Automate your API Portal administration workflow via CI/CD pipeline

  • Provider Information

    • Edit primary contact person for receiving emails

  • Company Information

    • Edit company information for internal reference

# Usage and Billing

  • Portal Plan Usage

    • Check your API quota and monetization usage

  • Portal Plan Billing

    • List all subscription payments

  • Plans and Pricing

    • View or Upgrade your Portal Plan

← Provider Mission - Add Your First API →