FabriXAPI User Guide

# Provider Mission - Add Your First API

# Introduction

In this mission, we will guide you on adding your first API to your API Portal powered by FabriXAPI.

To do so, you need to register as an API Provider on FabriXAPI. If you are not sure how to do so, please refer to Register as an API Provider and Generate API Portals.

# Key Steps

Adding your first API simply takes the following steps:

  1. Go to the Provider Admin Portal (opens new window) and log in to your account. If you need assistance finding your API Portal, please refer to How to Find My API Portals?

  2. Select the API Portal where you want to add your API.

  3. Create New API with required information

# Step-by-step Guide

  1. Go to Provider Admin Portal (opens new window) and log in to your account.

  1. You will see a list of API Portals you generated on this page. Navigate to a specific API Portal by clicking on it.

If you do not have an API portal, you can click on Generate Portal button to create one.

  1. Select the My APIs tab from the sidebar and click Create New API button to create a new API.

  1. Follow the 2 steps to complete a new API creation

    1. API Details

      Provide all the required information about the APIs.

    1. Upload API Specification

      Users have the option to upload their API Specification immediately or at a later time. It is important to note that without important a Swagger file, no endpoints will be visible, and you will not be able to set up plans and pricing for your API.

      By uploading the API Specification, your API will be more effectively presented in the API Portal, featuring an "OAS Ready" tag. Additionally, you will be able to test the functionality of your Swagger file. Therefore, it is highly recommended to upload your API Specification if it is available.

      If you decide to upload now, select Yes and use the Click to upload button to upload your API specification file if you already have one. For simplicity, If you do not have any API specification file, here we prepared a simple example-swagger.json for you from an open-source project (httpbin.org (opens new window)). You may download this file and upload it to the provider portal as your first API. Please note that we only support JSON format for the API specification file currently. Learn more about Upload Swagger Files or OpenAPI Specification.

      You will receive an email from FabriXAPI and you should see your API specification file uploaded correctly.

  2. Now you have created your first API. However, there are further steps you can take to maxmize the utilization and effectiveness of your API.

    # What's more

    To begin monetizing your APIs, you have the option to configure either public or private plans for each individual API. For more detailed information, please continue reading on:

Congratulations! You have successfully Added and Set Up Your First API. Please make use of this function to create more APIs for your API Portal on FabriXAPI. You may also try the Tutorial and Live Demo functions to improve the developer experience of your API. Now, you have completed Provider Mission - Add Your First API and your mission progress can be found in the Provider Admin Portal (opens new window).

Please go to Provider Mission - Get Your First API Subscriber and learn more essential skills on FabriXAPI.

# Credit

← Provider Mission - Get Your First API Subscriber →