Skip to main content

Install API Portal

Levo's API Portal is a powerful tool for API documentation and insight generation. Here's how it helps developers:

  • Clear API Documentation: It offers clean, interactive documentation that helps developers understand APIs quickly and effectively.
  • Interactive API Explorer: With its interactive API explorer, developers can explore APIs and understand the requests and responses associated with them.
  • Versioning and Change Management: The API Portal simplifies versioning and change management processes, ensuring developers always have access to the latest API documentation and updates.

By leveraging Levo's API Portal, developers can gain deep insights into their APIs and provide exceptional documentation experiences for their users.

Empower Developers:​

  • Centralized access: Streamline API discovery and exploration with a single source for all your APIs.
  • Comprehensive documentation: Auto-generated documentation directly from the OpenAPI Schema, providing clear and consistent information about every API endpoint, parameter, and response.
  • Search and filter: Easily find relevant APIs based on keywords, tags, or categories, saving developers time and effort.

Improve Customer Experience:​

  • Self-service portal: Empower developers to independently find and integrate with your APIs.
  • Reduced onboarding time: Get developers started quickly with comprehensive resources and support.
  • Increased developer satisfaction: Improve developer experience and foster a thriving API community.
  • Enhanced communication: Facilitate clear communication between you and your API users.

Installation​

Install via Docker​

Prerequisites​

  • Docker Engine version 18.03.0 and above.
  • Get the Auth/Refresh token from the Levo App User Profile page.

Installation Steps​

  • Run the following command to install the API Portal Docker container:
docker run --rm --name=levoai-api-portal \
-e REFRESH_TOKEN='<REFRESH_TOKEN>' --set levoOrgId="<LEVO_ORG_ID>" \
-p 8080:8080 levoai/api-portal:latest
NOTE:​
* If the user is part of multiple orgs, you would have to add --set levoOrgId="<LEVO_ORG_ID>" otherwise it is optional.​
* If you are running for an app from Levo's India SaaS instance, add this environment variable --set levoBaseUrl="https://api.india-1.levo.ai".​

  • Navigate to http://localhost:8080 to view the API docs.

Install via Helm Chart​

Prerequisites​

  • Get the Auth token from the Levo App User Profile page.

Installation Steps​

  • Add Levo Helm repo:
helm repo add levoai https://charts.levo.ai && helm repo update levoai
  • Run the following command to install the API Portal Helm Chart:
helm install levoai-api-portal levoai/levoai-api-portal \
--set levoAuthKey="your_auth_key" \
--set levoOrgId="your_org_id"
NOTE:​
* If the user is part of multiple orgs, you would have to add --set levoOrgId="<LEVO_ORG_ID>" otherwise it is optional.​
* If you are running for an app from Levo's India SaaS instance, add this environment variable --set levoBaseUrl="https://api.india-1.levo.ai".​

  • Port forward and navigate to http://localhost:8080 to view the API docs or setup LoadBalancer as per your requirements:
kubectl port-forward services/levoai-api-portal 8080:80

Install via Terraform​

Creating a Task Definition in your AWS Account using Terraform​

Download the

Loading...
file.

Run the following command in the same directory:

terraform apply

Enter the Auth Token, Env Name, and App Name as prompted to create a task definition for Levo's API Portal in your AWS account.