API Documentation

How it works

You issue certificates in Proudify as usual. The API lets your own website or app pull those certificates in and show them to your visitors, for example a "Our graduates" wall, a student portal, or a certificate page in your mobile app.

Quick start (5 minutes)

1. Create a token. In Proudify go to Profile → API Tokens, give it a name (e.g. "Website"), click Create Token and copy it. It is shown only once.
2. Make your first call from a terminal:

   curl https://proudify.in/api/v1/certificates?per_page=5 \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Accept: application/json"

3. Check the response. You get a data array of certificates plus links and meta for paging. Copy any image_url into your browser: it opens the certificate image with no token. That's the link your website will use.

Integration guide

A complete, working pattern: import every certificate, keep it up to date, and render an index and a detail page. Pick your language:

Step 1: Import all certificates

Request pages of 100 until links.next is null. Store each certificate by its uuid so re-running the import updates rows instead of duplicating them.

// sync-certificates.php (run from cron or your framework's scheduler)
$token = getenv('PROUDIFY_TOKEN');
$url   = 'https://proudify.in/api/v1/certificates?per_page=100&sort=updated_at&direction=asc';

// For later runs, only fetch what changed since the last sync:
// $url .= '&updated_since=' . urlencode($lastSyncTime);

while ($url) {
    $ch = curl_init($url);
    curl_setopt_array($ch, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER     => ["Authorization: Bearer $token", 'Accept: application/json'],
    ]);
    $page = json_decode(curl_exec($ch), true);
    curl_close($ch);

    foreach ($page['data'] as $cert) {
        saveCertificate($cert);   // INSERT ... ON DUPLICATE KEY UPDATE on uuid
    }

    $url = $page['links']['next'];   // null on the last page
}

// sync-certificates.js (Node 18+, run on a schedule)
const token = process.env.PROUDIFY_TOKEN;
let url = 'https://proudify.in/api/v1/certificates?per_page=100&sort=updated_at&direction=asc';

// For later runs: url += `&updated_since=${encodeURIComponent(lastSyncTime)}`;

while (url) {
  const res = await fetch(url, {
    headers: { Authorization: `Bearer ${token}`, Accept: 'application/json' },
  });
  if (res.status === 429) {                       // rate limited: wait and retry
    await new Promise(r => setTimeout(r, (+res.headers.get('Retry-After') || 60) * 1000));
    continue;
  }
  const page = await res.json();

  for (const cert of page.data) {
    await saveCertificate(cert);                  // upsert by cert.uuid
  }

  url = page.links.next;                          // null on the last page
}

Step 2: Choose what to store

Step 3: Index page (list of certificates)

<?php $certs = db()->query("SELECT * FROM certificates WHERE status = 'active' ORDER BY date_of_issue DESC"); ?>
<div class="cert-grid">
<?php foreach ($certs as $c): ?>
  <a href="/certificates/<?= htmlspecialchars($c['verification_code']) ?>">
    <img src="<?= htmlspecialchars($c['image_url']) ?>" alt="<?= htmlspecialchars($c['title']) ?>" loading="lazy">
    <h3><?= htmlspecialchars($c['recipient_name']) ?></h3>
    <p><?= htmlspecialchars($c['title']) ?></p>
  </a>
<?php endforeach; ?>
</div>

// Express route
app.get('/certificates', async (req, res) => {
  const certs = await db.certificates.findMany({ where: { status: 'active' }, orderBy: { date_of_issue: 'desc' } });
  res.render('certificates/index', { certs });
});

// certificates/index.ejs
<% certs.forEach(c => { %>
  <a href="/certificates/<%= c.verification_code %>">
    <img src="<%= c.image_url %>" alt="<%= c.title %>" loading="lazy">
    <h3><%= c.recipient_name %></h3>
  </a>
<% }) %>

Step 4: Show page (one certificate)

Read it from your database, or fetch it live with GET /certificates/{verification_code} if you don't store data. Either build the page yourself, or drop in the ready-made embed:

<!-- Option A: your own layout -->
<img src="{image_url}" alt="{title} awarded to {recipient_name}">
<a href="{pdf_url}">Download PDF</a>
<a href="{verify_url}" target="_blank" rel="noopener">Verify authenticity</a>

<!-- Option B: one line, styled for you -->
<iframe src="{embed_url}" style="width:100%;max-width:960px;aspect-ratio:1.25;border:0" loading="lazy"></iframe>

Step 5: Keep it in sync

• Run the Step 1 script on a schedule (hourly or nightly) with updated_since set to the time of the previous successful run. Revoked certificates come through as changes.
• When a certificate's status becomes revoked, hide it or show a "Revoked" badge on your site.
• If assets_available is false, your annual membership has lapsed and image/PDF links are paused until you renew. Show a placeholder.
• Stay under 60 requests per minute. With 100 per page that's 6,000 certificates per minute, so a full import is quick.

FAQ

Introduction

All API requests are made over HTTPS. The API returns JSON for all responses. Requests and responses are UTF-8 encoded. Timestamps are in ISO 8601 format.

Authentication

The API uses Bearer token authentication (Laravel Sanctum personal access tokens). Every request must include an Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Generating a token

1. Sign in to your Proudify account.
2. Go to Profile → API Tokens.
3. Enter a name for the token and click Create Token.
4. Copy the token immediately — it will not be shown again.

Base URL

All endpoints are prefixed with:

https://proudify.in/api/v1

Rate Limiting

The API is rate-limited to 60 requests per minute per token. When you exceed the limit you receive a 429 Too Many Requests response. The following headers are included in every response:

Errors

All error responses follow the same shape:

{
  "message": "Unauthenticated."
}

Returns a paginated list of all certificates issued by the authenticated user, sorted newest first.

Query Parameters

Example Request

# List the first 25 certificates
curl https://proudify.in/api/v1/certificates?per_page=25 \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

# Nightly sync: everything changed since the last run
curl "https://proudify.in/api/v1/certificates?updated_since=2025-06-01T00:00:00Z&sort=updated_at&direction=asc&per_page=100" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "uuid":               "01940e3d-bfa2-7b2e-aef0-c3db35e12abc",
      "title":              "Data Science – Batch 2025",
      "recipient_name":     "Priya Mehta",
      "recipient_email":    "priya@example.com",
      "description":        null,
      "date_of_issue":      "2025-06-01",
      "date_of_expiry":     null,
      "status":             "active",
      "verification_code":  "K7Q2XM4P",
      "verify_url":         "https://proudify.in/certificates/verify/...",
      "template":           { "id": 3, "name": "Classic Navy" },
      "assets_available":   true,
      "image_url":          "https://proudify.in/certificates/verify/.../image",
      "pdf_url":            "https://proudify.in/certificates/verify/.../download",
      "qr_url":             "https://proudify.in/certificates/verify/.../qr",
      "embed_url":          "https://proudify.in/certificates/embed/...",
      "created_at":         "2025-06-01T10:30:00+05:30"
    }
  ],
  "links": {
    "first": "https://proudify.in/api/v1/certificates?page=1",
    "last":  "https://proudify.in/api/v1/certificates?page=4",
    "prev":  null,
    "next":  "https://proudify.in/api/v1/certificates?page=2"
  },
  "meta": {
    "current_page": 1,
    "per_page":     25,
    "total":        87,
    "last_page":    4
  }
}

Returns a single certificate. The {uuid} segment accepts either the certificate's UUID or the human-readable Credential ID (e.g. K7Q2XM4P) printed on the certificate.

Path Parameters

Example Request

curl https://proudify.in/api/v1/certificates/01940e3d-bfa2-7b2e-aef0-c3db35e12abc \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

# Also works with the Credential ID printed on the certificate
curl https://proudify.in/api/v1/certificates/K7Q2XM4P \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Response

{
  "data": {
    "uuid":               "01940e3d-bfa2-7b2e-aef0-c3db35e12abc",
    "title":              "Data Science – Batch 2025",
    "recipient_name":     "Priya Mehta",
    "recipient_email":    "priya@example.com",
    "description":        null,
    "date_of_issue":      "2025-06-01",
    "date_of_expiry":     null,
    "status":             "active",
    "verification_code":  "K7Q2XM4P",
    "verify_url":         "https://proudify.in/certificates/verify/...",
    "created_at":         "2025-06-01T10:30:00+05:30"
  }
}

Streams the rendered certificate as a PNG image. Returns 404 if the image has not been generated yet.

Example Request

curl https://proudify.in/api/v1/certificates/01940e3d-bfa2-7b2e-aef0-c3db35e12abc/image \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  --output certificate.png

Downloads the certificate as a PDF file with a Content-Disposition: attachment header. Returns 404 with "The PDF is still being generated." if the file is not ready yet.

Example Request

curl https://proudify.in/api/v1/certificates/01940e3d-bfa2-7b2e-aef0-c3db35e12abc/download \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -L --output "certificate.pdf"

Streams the QR code for the certificate as a PNG image. Scanning the QR code opens the public verification page for the credential.

Example Request

curl https://proudify.in/api/v1/certificates/01940e3d-bfa2-7b2e-aef0-c3db35e12abc/qr \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  --output qr.png

Certificate Object

Fields returned inside data for every certificate endpoint.

Showing certificates on your website

Call the API from your server (your token stays secret), save or cache the results, then render them in your pages. The image_url, pdf_url, qr_url and embed_url fields are public links, so your visitors' browsers can load them directly without your token.

Option 1: build your own list and detail pages

<!-- Index: one card per certificate from GET /certificates -->
<a href="/certificates/K7Q2XM4P">
  <img src="{image_url}" alt="{title} – {recipient_name}" loading="lazy">
  <p>{recipient_name} · {title}</p>
</a>

<!-- Show: data from GET /certificates/{verification_code} -->
<img src="{image_url}" alt="{title}">
<a href="{pdf_url}">Download PDF</a>
<a href="{verify_url}" target="_blank">Verify</a>

Option 2: drop in the ready-made embed

No styling needed. Add ?image=0 to show only the name, status and verify link.

<iframe src="{embed_url}"
        style="width:100%;max-width:960px;aspect-ratio:1.25;border:0"
        loading="lazy" title="Certificate"></iframe>