Google-Sheets-Rate-Assistant/GUIDE_API_KEY.md

API Key Setup Guide

This guide explains how to create and configure API keys for use with the Google Sheets Rate Assistant. The application expects an apiKeys array in config.json (even a single key should be provided as a single-element array).

Overview

• The app supports using API keys instead of a service account by providing an apiKeys array in config.json.
• Each entry in apiKeys may be a string (the key) or an object with { key, rateLimitPerMinute }.

Create an API key

1. Go to the Google Cloud Console: https://console.cloud.google.com/
2. Select or create a project.
3. Enable the Google Sheets API (and Drive API if you need it) under "APIs & Services > Library".
4. Go to "APIs & Services > Credentials" and click Create credentials > API key. Copy the key value.

Secure the key

• Click Restrict key on the credentials page and set:
  • Application restrictions (IP addresses or HTTP referrers) where possible.
  • API restrictions: select Google Sheets API only.
• Do not leave keys unrestricted in production.

Configure the project

In config.json, add the keys under the apiKeys array. Here's an example using apiKeys:

To configure multiple keys with per-key rate limits:

{
  "apiKeys": [
    { "key": "API_KEY_1", "rateLimitPerMinute": 60 },
    { "key": "API_KEY_2", "rateLimitPerMinute": 30 }
  ]
}

The app will round-robin requests across configured keys and respect rateLimitPerMinute values.