myapi.rest – Developer Documentation

Build fast with four unified APIs: URL Shortener QR Codes Barcodes Image Hosting. One key. Shared analytics.

Getting started #

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

Ping API #

Check authentication and service availability. Returns status, service name, and current server time.

GET ping

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",
  "service": "myapi.rest",
  "time": "2025-09-22T14:45:03Z"
}

Errors #

We use standard HTTP status codes. Error payloads are 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"
}

URL Shortener API #

Create and manage short links with branded domains and analytics.

POST shorturl

curl --location 'https://myapi.rest/api/shorturl/generate' \
	--header 'Content-Type: application/json' \
	--header 'Authorization: Bearer <API_KEY>' \
	--data '{
	"long_url":"https://www.google.com/",
	"base_url":"https://grc.pw/",
	"expires_at":"2026-10-14 16:45:00"
}'

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://myapi.rest/api/shorturl/generate");
request.Headers.Add("Authorization", "Bearer <API_KEY>");
var content = new StringContent("{\r\n
		\"long_url\":\"https://www.google.com/\",\r\n
		\"base_url\":\"https://grc.pw/\",\r\n
		\"expires_at\":\"2026-10-14 16:45:00\"\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://www.google.com/",
"base_url": "https://grc.pw/",
"expires_at": "2026-10-14 16:45:00"
});

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

fetch("https://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://www.google.com/",
"base_url": "https://grc.pw/",
"expires_at": "2026-10-14 16:45:00"
})
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"
}

QR Code API #

Generate PNG or SVG QR codes.

POST qrcode

curl --location 'https://myapi.rest/qrcode' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_KEY>' \
--data '{
    "url":"https://example.com/landingpage",
    "type":"png",
    "logo_url":"https://example.com/assets/logo.png",      // optional
    "campaign_name":"spring-campaign"                      // optional
}'

using System.Net.Http;
		using System.Text;
		var http = new HttpClient();
		http.DefaultRequestHeaders.Add("Authorization", "Bearer <API_KEY>");

		var body = @"{
		  ""url"": ""https://example.com/landingpage"",
		  ""type"": ""png"",
		  ""logo_url"": ""https://example.com/assets/logo.png"",
		  ""campaign_name"": ""spring-campaign""
		}";

		var res = await http.PostAsync(
		  "https://myapi.rest/qrcode",
		  new StringContent(body, Encoding.UTF8, "application/json")
		);

		var json = await res.Content.ReadAsStringAsync();
		System.Console.WriteLine(json);

fetch("https://myapi.rest/qrcode", {
		  method: "POST",
		  headers: {
			"Content-Type": "application/json",
			"Authorization": "Bearer <API_KEY>"
		  },
		  body: JSON.stringify({
			url: "https://example.com/landingpage",
			type: "png",
			logo_url: "https://example.com/assets/logo.png",
			campaign_name: "spring-campaign"
		  })
		})
		.then(r => r.json())
		.then(console.log);

import requests

		headers = {
			"Authorization": "Bearer <API_KEY>",
			"Content-Type": "application/json"
		}

		payload = {
			"url": "https://example.com/landingpage",
			"type": "png",
			"logo_url": "https://example.com/assets/logo.png",
			"campaign_name": "spring-campaign"
		}

		r = requests.post("https://myapi.rest/qrcode", json=payload, headers=headers)
		print(r.json())

200 OK Response


{
	"qrcode": "<BASE_64_DATA>"
}

Barcode API #

Generate barcodes suitable for print and packaging.

POST barcode

curl --location 'https://myapi.rest/barcode' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_KEY>' \
--data '{
	"data":"1234567",
	"format":"UPC_E",
	"width":200,
	"height":50,
	"margin":0,
	"campaign_name":"spring-campaign"      // optional
}'

using System.Net.Http;
using System.Text;
var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer <API_KEY>");

var body = @"{
  ""data"": ""1234567"",
  ""format"": ""UPC_E"",
  ""width"": 200,
  ""height"": 50,
  ""margin"": 0,
  ""campaign_name"": ""spring-campaign""
}";

var res = await http.PostAsync(
  "https://myapi.rest/barcode",
  new StringContent(body, Encoding.UTF8, "application/json")
);

var json = await res.Content.ReadAsStringAsync();
System.Console.WriteLine(json);

fetch("https://myapi.rest/barcode", {
  method: "POST",
  headers: {
	"Content-Type": "application/json",
	"Authorization": "Bearer <API_KEY>"
  },
  body: JSON.stringify({
	data: "1234567",
	format: "UPC_E",
	width: 200,
	height: 50,
	margin: 0,
	campaign_name: "spring-campaign"
  })
})
.then(r => r.json())
.then(console.log);

import requests

headers = {
	"Authorization": "Bearer <API_KEY>",
	"Content-Type": "application/json"
}

payload = {
	"data": "1234567",
	"format": "UPC_E",
	"width": 200,
	"height": 50,
	"margin": 0,
	"campaign_name": "spring-campaign"
}

r = requests.post("https://myapi.rest/barcode", json=payload, headers=headers)
print(r.json())

200 OK Response

{
	"barcode": "<BASE_64_DATA>"
}

Image Upload API #

Upload an image as Base64 and receive a hosted URL in return.

POST image

curl --location 'https://myapi.rest/image' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_KEY>' \
--data '{
    "imagedata":"<BASE_64_DATA>",
    "imagename":"filename.jpg"
}'

using System.Net.Http;
using System.Text;

var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer <API_KEY>");

var body = @"{
  ""imagedata"": ""<BASE_64_DATA>"",
  ""imagename"": ""filename.jpg""
}";

var res = await http.PostAsync(
  "https://myapi.rest/image",
  new StringContent(body, Encoding.UTF8, "application/json")
);

var json = await res.Content.ReadAsStringAsync();
System.Console.WriteLine(json);

fetch("https://myapi.rest/image", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <API_KEY>"
  },
  body: JSON.stringify({
    imagedata: "<BASE_64_DATA>",
    imagename: "filename.jpg"
  })
})
.then(r => r.json())
.then(console.log);

import requests

headers = {
    "Authorization": "Bearer <API_KEY>",
    "Content-Type": "application/json"
}

payload = {
    "imagedata": "<BASE_64_DATA>",
    "imagename": "filename.jpg"
}

r = requests.post("https://myapi.rest/image", json=payload, headers=headers)
print(r.json())

200 OK Response

{
  "imageurl": "https://myapi.rest/image?wlBG0EIbG0"
}

Support & SLAs #

Starter: 99.9% uptime SLA, email support.
Business: 99.99% uptime SLA, priority (24h).
Enterprise: 99.99% uptime SLA, priority + chat