GitFables
Sign inGet Started

API Authentication

Learn how to authenticate your API requests with GitFables.

1

Overview

All API requests to GitFables require authentication using an API key.

API authentication ensures:

  • Only authorized applications can access your data
  • Secure communication between systems
  • Proper request tracking and rate limiting
  • Access control based on permissions
2

Getting an API Key

Generate your API key through the GitFables dashboard.

  1. Log in to your GitFables dashboard
  2. Go to Settings > API Keys
  3. Click "Generate New API Key"
  4. Give your key a name and select permissions
  5. Copy and securely store your API key

⚠️ Your API key will only be shown once. If you lose it, you'll need to generate a new one.

3

Using Your API Key

Include your API key in the Authorization header of your requests.

Authorization Header Format:

auth-header.txt
Bash
Authorization: Bearer your-api-key

API Authorization Header Format

Example Request:

curl-example.sh
Bash
curl -X GET \
  https://api.gitfables.com/v1/stories \
  -H "Authorization: Bearer your-api-key"

Example API Request with Authorization

4

API Key Security

Follow these security best practices to protect your API keys.

Never share your API key or commit it to version control

Use environment variables to store your API key

Rotate your API keys periodically

Use different API keys for development and production

5

Rate Limiting

API requests are rate limited based on your plan.

Free

100 requests per hour

Pro

1,000 requests per hour

Enterprise

Custom limits

Rate limit information in response headers:

response-headers
HTTP
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

Rate limit headers example