QRCode Generation and Decoding API

Generate qrcode for emails,bitcoin payments,business cards and more very easily. Read and decode the contents of an existing QrCode Image.

Full featured QR Code REST API

You can use our API to generate QR Code images for text, url, phone numbers, business cards are any other raw data. You can also send a QR Code Image and our API will decode and return you the contents. In short a full QR Code implementation is available to you via few REST API calls.

• Create QR codes via API calls (to integrate in your app, website etc)
• Read / scan QR codes via API calls (to integrate in your app, website etc)
• Encrypted communication via HTTPS (SSL/TLS)
• Super easy API
• Multiple file formats including vector formats for high resolution printing (EPS, SVG , PNG and RAW output)

API End Points

The end point for connecting : If you subscribe directly from us use this endpoint.

	https://api.interfaces.one

API Documentation

To create a QrCode for an email id with prepopulated subject and body use something like the following

   GET https://api.interfaces.one/api/qrcode/email

   Parameters
       [email protected]
       format=png
       subject=Qrcode
       body=Qrcode%20Generated%20from%20Interfaces%20One

It should generate a response like this

{
  "success": {
    "total": 4
  },
  "contents": {
    "encoding": "base64",
    "format": "png",
    "text": "mailto:[email protected]?subject=Qrcode&body=Qrcode+Generated+from+Interfaces+One",
    "content": "data:image/png;base64,iVBORw0KGgoAAAANS..."
  },
  "copyright": {
    "url": "https://interfaces.one",
    "year": "2024"
  }
}

Displaying the returned base64 encoded image

Here is an example to using the base64 encoded image in javascript.

var image = new Image();
image.src = apiresult.contents.content;
document.body.appendChild(image);

In PHP saving the returned base54 encoded image to a image file will look something like this.

$img_string = $result['contents']['content'];
$data = explode(',',$img_string);
file_put_contents("qrcode.png",base64_decode( $data[1] ));

Ratelimiting

Some of our API calls may be public(requires free API key) , while others requires paid subscription. To maintain our serice levels both public and private API endpoints are ratelimited. Please consult your specific plan that you subscribed to for the rate limit details.

Authentication

Currently we support API Key based authentication. Please set your Autorization Bearer request header with value of your API key. Alternatively you can also pass api_key= as a request parameter, though we strongly discourage this mode of passing the key, since it will allow others to see your key.

In curl this would mean sending the Authorization header like below.

            
 curl -i <url> -H "Authorization: Bearer <api_key>"
            
            

If you are using PHP.

            
$authorization = "Authorization: Bearer <api_key>";
$ch = curl_init('<url>'); // Initialise cURL
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json' , $authorization ));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); // OR GET
$result = curl_exec($ch);
curl_close($ch);
            
            

In javascript you can use headers key to add the authorization header

            
$.ajax({
   url: '<url>'
   type: 'GET',
   contentType: 'application/json'
   headers: {
      'Authorization': 'Bearer <api_key>'
   },
   success: function (result) {
       // CallBack(result);
   },
   error: function (error) {

   }
});