🖥️For Developers

Good to know: agumbe-ctl (pronounced Agumbe Control), is the CLI for the Agumbe Platform API.

1. System Integrations

Integrations with ticketing systems provides a traceable path of your development requests.

2. Platform API

The Platform API provides a robust set of functionalities for developers to interact directly with the system, enabling the creation, management, and deployment of resources. This powerful interface supports a diverse range of operations, making it a cornerstone for automating tasks and integrating with third-party systems.

Features

• Resource Management: Create, update, and delete resources with ease.

• Authentication and Authorization: Secure access with comprehensive authentication mechanisms.

• Real-time Data Access: Retrieve and manipulate data in real time.

• Scalability: Designed to scale with your application needs.

Getting Started

To begin utilizing the Platform API, you need to:

1. Obtain an API key by registering on the platform.

2. Familiarize yourself with the API documentation for detailed information on available endpoints.

3. # Example: Fetch list of resources
   curl -X GET 'https://portal.agumbe.ai/resources' \
   -H 'Authorization: Bearer YOUR_API_KEY'

   For detailed documentation and SDK downloads, visit our Developer Hub.

3. CLI

The Command Line Interface (CLI) is designed for developers who prefer working directly from the terminal. It offers an efficient way to interact with the platform by executing commands that allow you to manage resources, authenticate, access data in real-time, and scale your applications.

Getting Started with CLI

To get started with the CLI, follow these steps:

1. Download and install the CLI tool from the Developer Hub.

2. Configure the CLI with your API key:

   agumbe-ctl config set --api-key YOUR_API_KEY

4. Self-Service

The CLI offers a range of self-service functionalities that enable you to perform tasks without needing to contact support. This includes creating, modifying, and deleting resources directly from your terminal. Here's how to start:

agumbe-ctl create

Follow the on-screen instructions to navigate through the self-service options.

5. Deployment Automation

Leverage the CLI to automate your deployment processes. With simple commands, you can deploy your applications across different environments seamlessly. Begin automation with:

agumbe-ctl deploy /path/to/your/project.yaml --env development

Replace /path/to/your/project with the actual path of your project and --env development with your targeted environment.

6. Service Catalogue

Access a wide range of services directly from the CLI. The service catalogue allows you to browse and interact with available services, simplifying the process of integrating new features into your application. To view the service catalogue:

agumbe-ctl services list --active yes --env development

For more details on a specific service, use:

agumbe-ctl services describe --name SERVICE_NAME