Developer APIs

How Developer APIs Works with Botimum

Botimum provides a set of Developer APIs that allow you to interact with the platform programmatically. This guide will help you understand how to manage your API keys, check available APIs, and authenticate your requests.

Managing API Keys

To manage your API keys, follow these steps:

  1. Log in to the Botimum Console: Access the Botimum console and log in with your credentials.
  2. Navigate to My Profile: Once logged in, go to the “My Profile” section.
  3. Create a New API Key: If you don’t have an API key, you can create a new one by clicking the “Create New API Key” button.
  4. Revoke or Regenerate API Key: If you already have an API key, you can revoke or regenerate it using the respective buttons.

Checking Available APIs

Botimum provides a comprehensive API documentation through the Swagger UI. This interactive documentation allows you to explore all available APIs, their endpoints, request parameters, and response formats.

To access the Swagger UI, follow these steps:

  1. Open the Swagger UI: Visit the following link to open the Swagger UI in your browser:
  2. Explore the APIs: Use the Swagger UI to:
    • View detailed information about each API endpoint.
    • Understand the required request parameters and their formats.
    • See example responses and their structures.
    • Test API endpoints directly from the browser.

Authenticating API Requests

To authenticate your API requests, you need to include your API key in the X-API-KEY header. Here is an example of how to do this:

Example using curl

curl -X GET "https://api.botimum.com/apiv1/me" -H "X-API-KEY: your-api-key"

Requesting Additional API Features

If you need additional features or have specific requirements for the API that are not currently supported, please reach out to us. We are always looking to improve our services and would love to hear your feedback and suggestions.