@extends('master-user') @section('content')

API Documentation

@if(session('success'))
{{ session('success') }}
@endif

Generate Short URL API

This API generates a short URL for a given full URL. It requires a valid API key for authentication.

Endpoint

POST {!! env('APP_URL') !!}api/v1/shorten

Request Headers

Accept: application/json

Request Body

{"api_key": "YOUR_API_KEY","full_url": "https://example.com","merchant_id":"YOUR_MERCHANT_ID"}

Example cURL Request

curl --location '{!! env('APP_URL') !!}api/v1/shorten' \
  --header 'Accept: application/json' \
  --form 'api_key="YOUR_API_KEY"' \
  --form 'merchant_id="YOUR_MERCHANT_ID"' \
  --form 'full_url="https://example.com"'

Response

Success Response (200 OK):

{"success": true,"message": "Short URL generated successfully.","data": {"short_url": "{!! env('APP_URL') !!}abc123"}}

Error Response (401 Unauthorized):

{"success": false,"message": "Invalid Authentication."}

Error Response (400 Bad Request):

{"success": false,"message": "Invalid input.","errors": {"full_url": ["The full url field is required."]}}

Credit Balance

This API retrieves url credit balance.

Endpoint

POST {!! env('APP_URL') !!}api/v1/credits

Request Headers

Accept: application/json

Request Body

{"api_key": "YOUR_API_KEY","merchant_id":"YOUR_MERCHANT_ID"}

Example cURL Request

curl --location '{!! env('APP_URL') !!}api/v1/credits' \
  --header 'Accept: application/json' \
  --form 'api_key="YOUR_API_KEY"' \
  --form 'merchant_id="YOUR_MERCHANT_ID"'

Response

Success Response (200 OK):

{"success": true,"message": "Balance Fetched.","data": {"credits": 123}}

Error Response (401 Unauthorized):

{"success": false,"message": "Invalid Authentication."}
@endsection @push('head_end') @endpush