generate_key.rb

require 'dotenv/load'
require 'algolia'

# Algolia client credentials
ALGOLIA_APP_ID = ENV['ALGOLIA_APP_ID']
ALGOLIA_API_KEY = ENV['ALGOLIA_API_KEY']
ALGOLIA_INDEX_NAME = ENV['ALGOLIA_INDEX_NAME']

# Initialize the client and the index
# https://www.algolia.com/doc/api-client/getting-started/initialize/ruby/?client=ruby#initialize-the-search-client
client = Algolia::Search::Client.create(ALGOLIA_APP_ID, ALGOLIA_API_KEY)
index = client.init_index(ALGOLIA_INDEX_NAME)

# Set permissions for API key
# https://www.algolia.com/doc/api-reference/api-methods/add-api-key/?client=ruby#method-param-acl
acl = ['search']

# Set the rate limited parameters for API key
# https://www.algolia.com/doc/api-reference/api-methods/add-api-key/#method-param-maxqueriesperipperhour

opts = {
    description: "Restricted search-only API key limited to 100 API calls per hour",
    # Rate-limit to 100 requests per hour per IP address
    maxQueriesPerIPPerHour: 100
    }

# Create a new restricted search-only API key
puts "Creating new restricted search-only API key ..."

res = client.add_api_key(acl, opts)

# Print the new generated search api key
new_search_api_key = res.raw_response[:key]
puts "Your new Search only Rate Limited API Key is: #{new_search_api_key}"