Generating a Campaign Link API endpoint

[archx3]

As a
Frontend engineer
I want to
programmatically generate a campaign link through an API,
so that
I can seamlessly integrate campaign link generation into our systems and automate the process.

Acceptance Criteria

• Generating a Campaign Link

  Given I have valid API credentials and access rights,
  When I make a POST request to the endpoint with the required parameters (e.g., campaign ID, link ID),
  Then the specified link should be generated for the specified campaign,
  And I should receive a 201 Created status code along with the details of the newly generated campaign link.

• Invalid Request Handling

  Given I have valid API credentials and access rights,
  When I make a POST request to the endpoint with invalid or missing parameters,
  Then the system should respond with a 400 Bad Request status code,
  And provide appropriate error messages indicating the missing or invalid parameters.

• Unauthorized Request Handling

  Given I have invalid API credentials or access rights,
  When I make a POST request to the endpoint,
  Then the system should respond with a 401 Unauthorized status code,
  And provide an appropriate error message indicating the invalid credentials or access rights.

• Rate Limiting

  Given I have valid API credentials and access rights,
  When I make more than [Max Requests] requests to the endpoint within a [Time Period],
  Then the system should respond with a 429 Too Many Requests status code,
  And provide an appropriate error message indicating that the rate limit has been exceeded.

• API Documentation

  Given I have valid API credentials and access rights,
  When I make a GET request to the endpoint,
  Then the system should respond with a 200 OK status code,
  And provide a list of all available endpoints along with their required parameters and expected responses.