API Documentation

Introduction

Our API provides a powerful and flexible system for interacting with the link shortener service. It supports both public and private API endpoints, each serving different purposes based on user authentication and API token access.

• Production Base URL: https://cutr.it/api
• Protocol: HTTPS
• Content-Type: application/json
• Accept: application/json
• Authentication:
  • Public API endpoints do not require authentication.
  • Private API endpoints require an API token to be included in the request headers.
• Rate Limits: The API is rate-limited to 180 requests per minute per user for authenticated endpoints, and 30 requests per minute for public endpoints.

HTTP Status Codes

• 200 OK: The request was successful.
• 201 Created: A resource was successfully created.
• 400 Bad Request: The request was invalid or malformed.
• 401 Unauthorized: Authentication failed or API token is missing.
• 403 Forbidden: The user does not have permission to access the resource.
• 404 Not Found: The requested resource could not be found.
• 422 Unprocessable Entity: The requested resource have errors.
• 500 Internal Server Error: A server-side error occurred.

Authentication

To interact with private API endpoints, you should to provide API Token as Bearer token.

Example of Error Response

{
    "message": "General Error Message",
    "errors": {
        "{FIELD_1}": [
            "{FIELD_1} Error Message"
        ],
        "{FIELD_2}": [
            "{FIELD_2} Error Message"
        ],
        ...
    }
}