BotBye API

Introduction

View as Markdown

API for managing BotBye projects: supports CRUD operations on Projects, Custom Rules, Rate Limiters, and Requests.

This API is designed for managing projects within BotBye accounts. It provides a full set of CRUD operations for projects and associated resources, such as Custom Rules, Rate Limiters, Request Overview, and Requests. The API is aimed at developers, businesses, and anyone interested in integrating BotBye capabilities into their solutions.

🧭 Functionality:

  • Manage projects within BotBye accounts.
  • Create, update, delete, and retrieve information about Custom Rules.
  • Configure and manage Rate Limiters.
  • Monitor and analyze requests through Request Overview and Requests.

🌐 Technologies:

  • This API is built on REST architecture, ensuring easy integration and scalability.

🛠️ Use Cases:

  • Integration with partner applications and platforms to extend functionality.
  • Building custom solutions and products based on BotBye’s API.
  • Expanding your product line using the data and capabilities provided by the API.

🔐 Authentication & permissions:

  • Every request is authenticated with a personal access token sent in the X-Api-Key header. Create one in your BotBye account under Profile → Personal Access Tokens → Create Personal Access Token.
  • A token carries the scopes ticked when it was created, and it works only for the account it was created in. Scopes cannot be edited afterwards — create a new token instead.
  • Each endpoint below states two things, and they are not the same list:
    • Accepted permissions — the permission in the account’s ACL tree, i.e. what a user or ACL group must be granted.
    • Token scope — the checkbox to tick when creating the token, e.g. Account Phishing Projects Action. A scope covers a whole area, so one checkbox grants every permission in it (for example create, update and delete of phishing projects and their domains).