myapi.rest – Developer Documentation

Getting started #

Sign up here.
Create an API key in your dashboard.
Use the Ping API to test your setup.

Ping API # (GET)


	curl --location 'https://api.myapi.rest/api/ping' \
	--header 'Authorization: Bearer <API_KEY>' \
	--data ''


	var client = new HttpClient();
	var request = new HttpRequestMessage(HttpMethod.Get, "https://api.myapi.rest/api/ping");
	request.Headers.Add("Authorization", "Bearer <API_KEY>");
	var content = new StringContent("", null, "text/plain");
	request.Content = content;
	var response = await client.SendAsync(request);
	response.EnsureSuccessStatusCode();
	Console.WriteLine(await response.Content.ReadAsStringAsync());


	const myHeaders = new Headers();
	myHeaders.append("Authorization", "Bearer <API_KEY>");

	const raw = "";

	const requestOptions = {
	method: "GET",
	headers: myHeaders,
	body: raw,
	redirect: "follow"
	};

	fetch("https://api.myapi.rest/api/ping", requestOptions)
	.then((response) => response.text())
	.then((result) => console.log(result))
	.catch((error) => console.error(error));


	import http.client

	conn = http.client.HTTPSConnection("api.myapi.rest")
	payload = ''
	headers = {
	'Authorization': 'Bearer <API_KEY>'
	}
	conn.request("GET", "/api/ping", payload, headers)
	res = conn.getresponse()
	data = res.read()
	print(data.decode("utf-8"))

200 OK Response


{
	"status": "ok",
	"serverTimeUtc": "2025-11-24T09:12:42.4264558Z"
}

URL Shortener API # (POST)


	curl --location 'https://api.myapi.rest/api/shorturl/generate' \
	--header 'Content-Type: application/json' \
	--header 'Authorization: Bearer <API_KEY>' \
	--data '{
	"long_url": "https://jenturner.studio",
	"expires_at": "2026-11-15T10:01:57.102Z"
	}'


	var client = new HttpClient();
	var request = new HttpRequestMessage(HttpMethod.Post, "https://api.myapi.rest/api/shorturl/generate");
	request.Headers.Add("Authorization", "Bearer <API_KEY>");
	var content = new StringContent("{\r\n
                            \"long_url\": \"https://jenturner.studio\",\r\n
                            \"expires_at\": \"2026-11-15T10:01:57.102Z\"\r\n
                            }", null, "application/json");
	request.Content = content;
	var response = await client.SendAsync(request);
	response.EnsureSuccessStatusCode();
	Console.WriteLine(await response.Content.ReadAsStringAsync());


	const myHeaders = new Headers();
	myHeaders.append("Content-Type", "application/json");
	myHeaders.append("Authorization", "Bearer <API_KEY>");

	const raw = JSON.stringify({
	"long_url": "https://jenturner.studio",
	"expires_at": "2026-11-15T10:01:57.102Z"
	});

	const requestOptions = {
	method: "POST",
	headers: myHeaders,
	body: raw,
	redirect: "follow"
	};

	fetch("https://api.myapi.rest/api/shorturl/generate", requestOptions)
	.then((response) => response.text())
	.then((result) => console.log(result))
	.catch((error) => console.error(error));


	import http.client
	import json

	conn = http.client.HTTPSConnection("api.myapi.rest")
	payload = json.dumps({
	"long_url": "https://jenturner.studio",
	"expires_at": "2026-11-15T10:01:57.102Z"
	})
	headers = {
	'Content-Type': 'application/json',
	'Authorization': 'Bearer <API_KEY>'
	}
	conn.request("POST", "/api/shorturl/generate", payload, headers)
	res = conn.getresponse()
	data = res.read()
	print(data.decode("utf-8"))

200 OK Response


{
	"shorturl": "https://grc.pw/Z7hye8b"
}

Click Event Webhook Payload


{
    "occurredAt": "2025-12-01 06:11:08",
    "id": "18",
    "code": "KJPwJbu",
    "domain": "grc.pw",
    "ip": "105.245.231.156",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/142.0.0.0 Safari/537.36",
    "referer": "",
    "accept_language": "en-ZA,en-GB;q=0.9,en-US;q=0.8,en;q=0.7"
}

QR Code API # (POST)


    curl --location 'https://api.myapi.rest/api/qrcode/generate' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <API_KEY>' \
    --data '{
    "data": "https://marquis.it.com",
    "output_format": "PNG",
    "pixels_per_module": 20,
    "margin": 0,
    "ecc_level": "H",
    "dark_color_hex": "#000000",
    "light_color_hex": "#FFFFFF",
    "draw_quiet_zones": true,
    "image_base64": "",
    "logo_size_percent": 20
    }'


    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://api.myapi.rest/api/qrcode/generate");
    request.Headers.Add("Authorization", "Bearer <API_KEY>");
    var content = new StringContent("{\r\n
                            \"data\": \"https://marquis.it.com\",\r\n
                            \"output_format\": \"PNG\",\r\n
                            \"pixels_per_module\": 20,\r\n
                            \"margin\": 0,\r\n
                            \"ecc_level\": \"H\",\r\n
                            \"dark_color_hex\": \"#000000\",\r\n
                            \"light_color_hex\": \"#FFFFFF\",\r\n
                            \"draw_quiet_zones\": true,\r\n
                            \"image_base64\": \"\",\r\n
                            \"logo_size_percent\": 20\r\n
                            }", null, "application/json");
    request.Content = content;
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    Console.WriteLine(await response.Content.ReadAsStringAsync());


    const myHeaders = new Headers();
    myHeaders.append("Content-Type", "application/json");
    myHeaders.append("Authorization", "Bearer <API_KEY>");

    const raw = JSON.stringify({
    "data": "https://marquis.it.com",
    "output_format": "PNG",
    "pixels_per_module": 20,
    "margin": 0,
    "ecc_level": "H",
    "dark_color_hex": "#000000",
    "light_color_hex": "#FFFFFF",
    "draw_quiet_zones": true,
    "image_base64": "",
    "logo_size_percent": 20
    });

    const requestOptions = {
    method: "POST",
    headers: myHeaders,
    body: raw,
    redirect: "follow"
    };

    fetch("https://api.myapi.rest/api/qrcode/generate", requestOptions)
    .then((response) => response.text())
    .then((result) => console.log(result))
    .catch((error) => console.error(error));


    import http.client
    import json

    conn = http.client.HTTPSConnection("api.myapi.rest")
    payload = json.dumps({
    "data": "https://marquis.it.com",
    "output_format": "PNG",
    "pixels_per_module": 20,
    "margin": 0,
    "ecc_level": "H",
    "dark_color_hex": "#000000",
    "light_color_hex": "#FFFFFF",
    "draw_quiet_zones": True,
    "image_base64": "",
    "logo_size_percent": 20
    })
    headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <API_KEY>'
    }
    conn.request("POST", "/api/qrcode/generate", payload, headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))

200 OK Response


{
    "id": 5,
    "qrcode": "<BASE_64_DATA>"
}

Barcode API # (POST)


    curl --location 'https://api.myapi.rest/api/barcode/generate' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <API_KEY>' \
    --data '{
    "data": "DEC25-45PC",
    "barcode_format": "code_128",
    "output_format": "SVG",
    "width": 200,
    "height": 50,
    "margin": 0
    }'


    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://api.myapi.rest/api/barcode/generate");
    request.Headers.Add("Authorization", "Bearer e46225ce.b12af93824696c08d3ba9dbf93a67c2ccfdb8849440708567e08f06722da721f");
    var content = new StringContent("{\r\n
                            \"data\": \"DEC25-45PC\",\r\n
                            \"barcode_format\": \"code_128\",\r\n
                            \"output_format\": \"SVG\",\r\n
                            \"width\": 200,\r\n
                            \"height\": 50,\r\n
                            \"margin\": 0\r\n
    }", null, "application/json");
    request.Content = content;
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    Console.WriteLine(await response.Content.ReadAsStringAsync());


    const myHeaders = new Headers();
    myHeaders.append("Content-Type", "application/json");
    myHeaders.append("Authorization", "Bearer <API_KEY>");

    const raw = JSON.stringify({
    "data": "DEC25-45PC",
    "barcode_format": "code_128",
    "output_format": "SVG",
    "width": 200,
    "height": 50,
    "margin": 0
    });

    const requestOptions = {
    method: "POST",
    headers: myHeaders,
    body: raw,
    redirect: "follow"
    };

    fetch("https://api.myapi.rest/api/barcode/generate", requestOptions)
    .then((response) => response.text())
    .then((result) => console.log(result))
    .catch((error) => console.error(error));


    import http.client
    import json

    conn = http.client.HTTPSConnection("api.myapi.rest")
    payload = json.dumps({
    "data": "DEC25-45PC",
    "barcode_format": "code_128",
    "output_format": "SVG",
    "width": 200,
    "height": 50,
    "margin": 0
    })
    headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <API_KEY>'
    }
    conn.request("POST", "/api/barcode/generate", payload, headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))

200 OK Response


{
    "id": 5,
    "barcode": "<BASE_64_DATA>"
}

Image Upload API # (POST)


    curl --location 'https://api.myapi.rest/api/image/upload' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <API_KEY>' \
    --data '{
    "file_base64": "<BASE_64_DATA>",
    "file_name": "logo.png"
    }'


    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://api.myapi.rest/api/image/upload");
    request.Headers.Add("Authorization", "Bearer <API_KEY>");
    var content = new StringContent("{\r\n
                                    \"file_base64\": \"<BASE_64_DATA>\",\r\n
                                    \"file_name\": \"logo.png\"\r\n
    }", null, "application/json");
    request.Content = content;
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    Console.WriteLine(await response.Content.ReadAsStringAsync());


    const myHeaders = new Headers();
    myHeaders.append("Content-Type", "application/json");
    myHeaders.append("Authorization", "Bearer <API_KEY>");

    const raw = JSON.stringify({
    "file_base64": "<BASE_64_DATA>
        ",
        "file_name": "logo.png"
        });

        const requestOptions = {
        method: "POST",
        headers: myHeaders,
        body: raw,
        redirect: "follow"
        };

        fetch("https://api.myapi.rest/api/image/upload", requestOptions)
        .then((response) => response.text())
        .then((result) => console.log(result))
        .catch((error) => console.error(error));


    import http.client
    import json

    conn = http.client.HTTPSConnection("api.myapi.rest")
    payload = json.dumps({
    "file_base64": "<BASE_64_DATA>",
        "file_name": "logo.png"
        })
        headers = {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer <API_KEY>'
        }
        conn.request("POST", "/api/image/upload", payload, headers)
        res = conn.getresponse()
        data = res.read()
        print(data.decode("utf-8"))

200 OK Response


{
    "id": "11",
    "url": "https://myapi.rest/images/11/29086085d6124aeabb7629c013563d3f.png",
    "size": 1592,
    "content_type": "image/png",
    "ms": 67
 }

Errors #

We use standard HTTP status codes. Sample JSON:

{
	"type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
	"title": "API Key validation error",
	"status": 500,
	"detail": "The API key provided could not be validated",
	"instance": "/api/ping"
}