Authentifizierung
Alle /api/v1-Endpunkte erfordern einen Bearer-API-Schlüssel.
Authorization-Header
Senden Sie Ihren Schlüssel im Authorization-Header:
Authorization: Bearer sk_live_your_key_here
Wenn der Header fehlt oder ungültig ist, gibt die API zurück:
{ "error": "Missing Authorization Bearer token" }
oder:
{ "error": "Invalid API key" }
API-Schlüssel erstellen und verwalten
Erstellen, auflisten und widerrufen Sie Schlüssel unter:
https://armox.ai/app/settings/api-keys
Jeder Schlüssel hat:
namekey_prefixexpires_at(optional)rate_limit_per_minuteis_active
Wichtig: Vollständige Schlüsselwerte werden nur einmalig bei der Erstellung angezeigt.
Schlüsselformat
Armox-API-Schlüssel verwenden dieses Präfix:
sk_live_...
Behandeln Sie Schlüssel wie Passwörter.
Anfrage-Beispiele
cURL
curl -X GET "https://armox.ai/api/v1/models" \
-H "Authorization: Bearer sk_live_your_key_here"
JavaScript (fetch)
const response = await fetch("https://armox.ai/api/v1/models", {
method: "GET",
headers: {
Authorization: "Bearer sk_live_your_key_here",
},
});
const data = await response.json();
console.log(data);
Python
import requests
response = requests.get(
"https://armox.ai/api/v1/models",
headers={"Authorization": "Bearer sk_live_your_key_here"},
)
print(response.status_code)
print(response.json())
Go
package main
import (
"fmt"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://armox.ai/api/v1/models", nil)
req.Header.Set("Authorization", "Bearer sk_live_your_key_here")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
fmt.Println("Status:", resp.StatusCode)
}
Zugangsvoraussetzungen
Der Zugang zur öffentlichen API erfordert ein berechtigtes Abonnement:
- Agency
- Master / Business
- Enterprise
Wenn das Benutzerkonto nicht berechtigt ist, gibt die API zurück:
{
"error": "Public API access requires Agency, Master/Business, or Enterprise plan."
}
Best Practices für die Sicherheit
- Verwenden Sie einen Schlüssel pro Umgebung (Entwicklung, Staging, Produktion)
- Rotieren Sie Schlüssel regelmäßig
- Widerrufen Sie kompromittierte Schlüssel sofort
- Setzen Sie API-Schlüssel niemals in Frontend-/Browser-Code ein
- Speichern Sie Schlüssel in serverseitigen Secret-Managern
- Beschränken Sie den internen Zugriff nach Service/Konto