Getting Started

Welcome to the API documentation! This guide will help you quickly set up and start interacting with our API. Follow the steps below to get started.

1. Overview

Our API provides a robust interface for managing tasks, spam, bots, and other functionalities essential for your application. Whether you're looking to create tasks, retrieve spam records, or manage bot interactions, our API has you covered.

Want to learn about writing content from scratch? Head to the Basics section to learn more.

2. Prerequisites

Before you begin, ensure you have the following:

• API Key / Access Token: You need an authorization token to access the API. This can be obtained by signing up on our platform and creating an application.

• API Client: You can use tools like Postman, cURL, or any HTTP client library (like Axios or Fetch) in your preferred programming language to make API calls

3. Authentication

Our API uses Bearer token authentication. You must include your token in the Authorization header of your requests.

Example Header:

Authorization: Bearer your_token_here

Our API uses API Key authentication. You must include your API key in the x-api-key header of your requests.

Example Header:

x-api-key: your_api_key_here

4. Making Your First API Call

1. Tasks

   • Create Task

     • POST /v1/tasks

     • Description: Create a new task.

   • Get Tasks

     • GET /v1/tasks

     • Description: Retrieve a list of tasks.

   • Get Task by ID

     • GET /v1/tasks/{id}

     • Description: Retrieve details of a specific task.

2. Spam

   • Get Spam Records

     • GET /v1/spams

     • Description: Retrieve spam records based on filters.

   • Get Spam by ID

     • GET /v1/spams/{id}

     • Description: Retrieve details of a specific spam record.

3. Bots

• Create Bot

  • POST /v1/bots

  • Description: Create a new bot

• Get Bots

  • GET /v1/bots

  • Description: Retrieve a list of bots.

• Get Bot by ID

  • GET /v1/bots/{id}

  • Description: Retrieve details of a specific bot.

1. Group

• Create Group

  • POST /v1/customers/groups

  • Description: Create a new customer group for organizing customers.

• Get Groups

  • GET /v1/customers/groups

  • Description: Retrieves a list of all customer groups.

1. User

• Import User

  • POST /v1/customers/batch

  • Description: Import customers into the system

5. Error Handling

If there are issues with your request, the API will respond with an error code and message. For example:

{
    "statusCode": 400,
    "message": "Bad Request",
    "error": "Validation failed"
}

Common error codes include:

• 400: Bad Request - Invalid parameters or missing required fields.

• 401: Unauthorized - Invalid or missing authentication token.

• 404: Not Found - The requested resource does not exist.

• 500: Internal Server Error - Something went wrong on the server

6. Rate Limiting

To ensure fair usage and stability, our API has rate limits in place. Be mindful of these limits when designing your application to avoid being throttled.

7. Next Steps

Now that you're familiar with the basics, check out the following sections in this documentation:

• API Endpoints: Detailed descriptions of each available API endpoint.

• Authentication: In-depth information about token management and security practices.

• Error Codes: A comprehensive list of potential error responses.