HTTP

TempDB provides a RESTful HTTP API for interacting with your database, allowing you to store, retrieve, and manage data seamlessly. This guide explains how to set up and use the HTTP API with an API k

Usage

Following is how to get started

Step 1: Generate an API Key

To interact with TempDB via HTTP, you need an API key for authentication.

1. Log in to the TempDB Console:

   • Visit our cloud and sign in with your credentials.

   • If you don’t have an account, sign up for free.

2. Create an API Key:

   • Navigate to the API Keys section in the console.

   • Click Generate New API Key.

   • Provide a name for the key (e.g., "MyAppKey") and select the appropriate permissions (e.g., read, write).

   • Save the generated key (e.g., YOUR_API_KEY). Note: Store this key securely, as it will not be shown again.

Step 2: Make HTTP Requests

Use your API key to authenticate requests to TempDB's HTTP endpoints. All requests must include the Authorization: Bearer YOUR_API_KEY header.

Example: Storing Data with curl

You can store data in TempDB using the /STORE endpoint. Below is an example using curl:

curl -X POST https://api.tempdb.xyz/v0/STORE \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "product:1",
    "value": {
      "name": "Laptop",
      "price": 999.99,
      "stock": 50,
      "location": "Eswatini"
    }
  }'

Response

jsonCollapseWrapCopy{ "success": true, "timestamp": "2024-01-14T12:00:00Z", "key": "product:1", "message": "Data stored successfully" } Best Practices

• Secure Your API Key: Never expose your API key in public repositories or client-side code. Use environment variables or a secrets manager.

• Rate Limits: Be aware of TempDB's rate limits (e.g., 1000 requests per minute). Check the response headers for X-RateLimit-Remaining to monitor your usage.

• Error Handling: Handle errors gracefully by checking the success field in responses. Common errors include:

  • 401 Unauthorized: Invalid or missing API key.

  • 400 Bad Request: Malformed request body.