Proofio API Documentation

Complete API documentation for retrieving and managing reviews from various sources.

Quick Start

1. Get Your API Key

Log in to the dashboard at dash.proofio.app
Create a new project
Copy your API key from the project settings

All public API endpoints require an API key in the header:

x-api-key: YOUR_API_KEY

2. Install the SDK (Recommended)

Use our official npm package for the easiest integration:

npm install proofio-sdk

Example: Using the SDK

import { Proofio } from 'proofio-sdk';

const proofio = new Proofio({ apiKey: 'YOUR_API_KEY' });

// List reviews
const reviews = await proofio.reviews.list();

// Get insights summary
const summary = await proofio.insights.summary();

console.log(`Total Reviews: ${summary.totalReviews}`);
console.log(`Average Rating: ${summary.averageRating}`);

3. Or Use the API Directly

Here's a complete example using JavaScript/TypeScript to fetch reviews directly:

Example: Fetch Reviews

const API_KEY = 'YOUR_API_KEY';
const BASE_URL = 'https://api.proofio.app/api/v1/public';

async function fetchReviews() {
  const response = await fetch(`${BASE_URL}/reviews`, {
    headers: {
      'x-api-key': API_KEY,
    },
  });
  
  if (!response.ok) {
    throw new Error(`API Error: ${response.status}`);
  }
  
  const reviews = await response.json();
  return reviews;
}

// Usage
const reviews = await fetchReviews();
console.log(reviews);