Ultimate Guide to API Keys

API Key Connection Guide (Onboarding Audit)

Updated from onboarding audit T-1083 and support escalations. These checks incorporate fixes from PRs #5147, #5149, and #5145 so first-call setup is clearer and faster.

1. Generate a new key and copy the full value before closing the creation dialog. Masked dashboard values are reference-only.
2. For REST requests, send the Authorization header with the Bearer scheme exactly once per request.
3. Use a known-good path first: /api/v1/email/[email protected].
4. When using SDKs, use the per-language quickstart pages instead of mixing SDK constructors with raw REST header patterns.

API Keys

KhaleejiAPI uses API keys to authenticate requests. You can view and manage your API keys in your dashboard.

Authentication Method

Every request must include your API key in the Authorization header using the Bearer scheme. This is the canonical and recommended method for all new integrations. Legacy clients may still use x-api-key as a compatibility fallback, but Authorization: Bearer is the standard going forward.

curl -X GET "https://khaleejiapi.dev/api/v1/ip/lookup?ip=8.8.8.8" \
  -H "Authorization: Bearer YOUR_API_KEY"

Common Pitfalls

These are the most frequent mistakes that cause authentication errors on the first call.

curl -H "Authorization: Bearer kapi_live_your_key_here" \
  https://khaleejiapi.dev/api/v1/ip/lookup

Authorization: kapi_live_your_key_here

Authorization: Bearer kapi_live_your_key_here

// TypeError at runtime
const client = new KhaleejiAPI('kapi_live_...');

const client = new KhaleejiAPI({
  apiKey: 'kapi_live_your_key_here',
});

Using SDKs

Our official SDKs handle authentication automatically. Initialize the client once with your API key and every subsequent request is authenticated for you.

import { KhaleejiAPI } from '@khaleejiapi/sdk';
 
// Pass an options object — apiKey is a required named property
const client = new KhaleejiAPI({ apiKey: 'kapi_live_your_key_here' });
 
// All subsequent requests are automatically authenticated
const result = await client.geo.lookupIp({ ip: '8.8.8.8' });

from khaleejiapi import KhaleejiAPI
 
# Initialize with your API key
client = KhaleejiAPI("kapi_live_your_key_here")
 
# All subsequent requests are automatically authenticated
result = client.geo.lookup_ip("8.8.8.8")

package main
 
import (
    "context"
    "fmt"
    khaleejiapi "github.com/khaleejiapi/sdk-go"
)
 
func main() {
    client := khaleejiapi.New("kapi_live_your_key_here")
    ctx := context.Background()
 
    ip, _ := client.Geo.LookupIp(ctx, "8.8.8.8")
    fmt.Println(ip.Country)
}

import KhaleejiAPI
 
let client = KhaleejiAPI(apiKey: "kapi_live_your_key_here")
 
let ip = try await client.geo.lookupIp("8.8.8.8")
print(ip.country)

import dev.khaleejiapi.KhaleejiAPI
 
val client = KhaleejiAPI("kapi_live_your_key_here")
 
val ip = client.geo.lookupIp("8.8.8.8")
println(ip.country)

<?php
use KhaleejiAPI\KhaleejiAPI;
 
$client = new KhaleejiAPI('kapi_live_your_key_here');
 
$ip = $client->geo->lookupIp('8.8.8.8');
echo $ip['country'];

Best Practices

# .env.local  (never commit this file)
KHALEEJI_API_KEY=kapi_live_your_key_here

// JavaScript / TypeScript — pass an options object
const client = new KhaleejiAPI({ apiKey: process.env.KHALEEJI_API_KEY! });

# Python
import os
client = KhaleejiAPI(os.environ["KHALEEJI_API_KEY"])