API Documentation: create ads

Endpoint

POST /api/ads/create

Description

This endpoint is used for submitting a new advertisement or content. It validates the input fields and processes the submission based on the provided data.

Request

Headers

• Content-Type: application/json
• 


Body Parameters

• token: string (required)
  • The user’s unique token for authentication.
• website_link: string (optional)
  • A URL to the website. Required if ads type 1.
• banner_image: file (optional)
  • An image file (jpeg, jpg, png, gif). Required if ads type 2.
• script: string (optional)
  • A script code. Required if ads type 3.
• youtube: string (optional)
  • A YouTube video URL. Required if ads type 4.
• max_show: integer (required)
  • The maximum number of times the content can be shown. Must be at least 1.
• title: string (required)
  • The title of the advertisement or content.
• duration: integer (required)
  • The duration of the advertisement in seconds.
• ads_type: integer (required)
  • The type of advertisement. Supported values:
    • 1: Website Link
    • 2: Banner Image
    • 3: Script (HTML/JS)
    • 4: YouTube

    • schedule: array (optional)

      • An array of schedules specifying when the advertisement should run. Each schedule includes:

        • day: string (required) - The day of the week (e.g., "sunday").

        • start: string (required) - The start time in HH:mm format.

        • end: string (required) - The end time in HH:mm format.

        • 
          

Example Request

{
    "token": "user_token_123",
    "website_link": "https://example.com",
    "max_show": 10,
    "title": "Example Ad",
    "duration": 30,
    "ads_type": 1
}

Response

Success Response

Status Code: 200 OK

Body:

{
    "status": true,
    "message": "Content submitted successfully."
}

Error Responses

Validation Errors

Status Code: 422 Unprocessable Entity

Body:

{
    "errors": {
        "token": ["The token field is required."],
        "max_show": ["The max show must be at least 1."],
        "title": ["The title field is required."],
        "duration": ["The duration field is required."],
        "ads_type": ["The ads type field is required."]
    }
}

Validation Rules

• token: Required.
• website_link: Optional, must be a valid URL. Required if ads type 1.
• banner_image: Optional, must be a valid image file. Required if ads type 2.
• script: Optional, required if ads type 3.
• youtube: Optional, must be a valid URL. Required if ads type 4.
• max_show: Required, must be an integer and at least 1.
• title: Required.
• duration: Required, must be an integer.
• ads_type: Required. Must be one of the supported values (1, 2, 3, or 4).

• schedule: Optional, must be an array of objects with day, start, and end keys.