Skip to main content

Admin Guide

The VeeCode Platform offers a powerful API Management solution. In this module, we will guide you through the process of setting up and managing API services, security, rate-limiting, and partner access. This documentation assumes you have already configured an API Gateway within your Developer Portal.

Overview​

The API Management module has two main components:

  1. Admin: The administrator, or "Admin," is responsible for creating and configuring services, applying security layers such as key-auth or OAuth2, and managing rate-limiting. The Admin can also grant and revoke access to partners for specific services and create applications on behalf of partners.
  2. Partner: Partners are created by Admins and granted access to specific services. They can create applications within their assigned services and manage API credentials.

Disclaimer: When using Kong-readmode-only, it is assumed that the Admin has already made the necessary configurations within the Kong Dashboard, including plugin setup and consumer group creation. In this mode, the VeeCode Platform will not handle these configurations for you.

Setting Up API Services​

As an Admin, you can create and manage API services to control how your APIs are exposed, consumed, and secured. Follow these steps to set up a new service:

  1. Log in to the Developer Portal as an Admin.
  2. Navigate to the "Services" section in the side menu.
  3. Click on "Create Service" and fill in the required information, such as the service name, the corresponding API Gateway Service Name (from the dropdown list), status, and description.
  4. Choose the security plugin (key-auth or OAuth2) to apply the desired authentication method to your service.
  5. Optionally, you can add a rate-limiting plugin to control the number of requests allowed per time interval.
  6. Save the new service.

Once the service is created, it will be listed on the "Services" page. You can click on a specific service to view its details and edit its settings.

Managing Security and Rate-Limiting​

The VeeCode Platform allows you to apply different security mechanisms and rate-limiting settings to your services, ensuring that your APIs are protected and performant:

  • Key-auth: This authentication method requires clients to provide an API key with each request. The Admin can create, manage, and revoke API keys as needed.
  • OAuth2: This method uses the OAuth 2.0 protocol to secure your APIs, allowing for more advanced and flexible authentication and authorization scenarios.
  • Rate-limiting: This feature helps you control the number of requests that can be made to your services within a specific time interval, preventing abuse and ensuring fair usage.

Managing Partner Access​

As an Admin, you can manage partners and their access to the services you have created. To create partners, they must first register themselves in the Developer Portal. Follow these steps:

  1. Log in to the Developer Portal as an Admin.
  2. Navigate to the "Partners" section in the side menu.
  3. Click on "Create Partner" and fill in the required information, such as the partner's name, email, phone number, and the services they should have access to.
  4. Save the new partner.

The newly created partner will be listed on the "Partners" page. To view or edit their information or to grant or revoke access to services, click on the "More Information" button next to the partner's name.

Managing Partner Applications​

Admins can now create applications for partners, following a process similar to the partner's own application creation:

  1. Navigate to the "Applications" section in the side menu.
  2. Click on "Create Application" and fill in the required information, such as the application name, description, and associated services.
  3. Choose the creator of the application from the dropdown list (Admin or Partner).
  4. Save the new application.

By following this guide, you can effectively manage your APIs, services, and partner access within the VeeCode Platform. This comprehensive solution ensures a secure and efficient API ecosystem for your organization and partners, allowing for smooth collaboration and streamlined API management. With the VeeCode Platform API Management module, you can confidently maintain control over your APIs while providing partners with the tools and access they need to succeed.