Quickstart

Connect to your Supabase database and run the following SQL commands:

select dbdev.install('keyhippo@keyhippo');
create extension "keyhippo@keyhippo" version '0.0.33';

This installs the KeyHippo extension, making its functions available in your database environment.

Install the KeyHippo client package in your project:

npm install keyhippo

This package provides the client-side implementation for seamless API key management.

Use the following code to create a new API key for a user:

import { KeyHippo } from "keyhippo";

const keyHippo = new KeyHippo(supabaseClient);
const result = await keyHippo.createApiKey(userId, "Primary API Key");

This generates a new API key and associates it with the specified user.

Create a Row Level Security policy that incorporates KeyHippo:

CREATE POLICY "owner_access"
ON "public"."resource_table"
USING (
  auth.uid() = resource_table.owner_id
  OR auth.keyhippo_check(resource_table.owner_id)
);

This policy allows access when the user is authenticated via a session token or a valid API key.