Authentication

Every call to the Runtime API is authenticated with a signature generated from your domain’s keys. Get both keys from the Domains page in your PitchPrint admin.

Key	Where it runs
API Key	Public-facing. Identifies your domain on each request.
Secret Key	Server-side only. Used to build the signature. Never sent in a request.

Never expose your Secret Key in client-side code, a public repository, or a mobile app bundle. Anyone holding it can edit your PitchPrint account. Use it only from your server.

Generate a signature

Append your API Key + Secret Key + timestamp and take the MD5 hash of the resulting string. That hash is your signature. The timestamp is a UNIX timestamp (seconds since the epoch) and is valid for a one-hour window, so generate a new signature for each request.

Protect the script that generates your signature so that only code with the right privileges can call it, since it has access to your Secret Key.

<?php
    define('PITCH_APIKEY', 'your-api-key');
    define('PITCH_SECRETKEY', 'your-secret-key');

    function generateSignature () {
        $timestamp = time();
        $signature = md5(PITCH_APIKEY . PITCH_SECRETKEY . $timestamp);
        return array ('timestamp'=>$timestamp, 'apiKey'=>PITCH_APIKEY, 'signature'=>$signature);
    }
?>

const md5 = require('md5'); // you need the md5 module

function generateSignature () {
  const timestamp = Math.floor(Date.now() / 1000);
  const apiKey = 'your-api-key';
  const secretKey = 'your-secret-key';
  const signature = md5(apiKey + secretKey + timestamp);
  return { timestamp, apiKey, signature };
}

Sending the request

Send apiKey, timestamp and signature, plus any endpoint-specific fields, as a JSON body. The endpoint for all runtime calls is https://api.pitchprint.io/runtime/.

Pass the parameters as a JSON string, not query-string pairs. For example: curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($opts));

Fetch Design

Retrieve the source data for a single design by its designId.

Fetch Designs

List all designs under a given category.

Fetch Project

Retrieve the source data for a single project by its projectId.

Clone Project

Clone an existing project associated with your domain.

Overview

Custom Integration

Designer API

Runtime API

Developer Knowledge Base

Generate a signature

Sending the request

Fetch Design

Fetch Designs

Fetch Project

Clone Project

​Generate a signature

​Sending the request

​Related articles

Fetch Design

Fetch Designs

Fetch Project

Clone Project

Generate a signature

Sending the request

Related articles