Zum Hauptinhalt springen
Entwickler-Ressourcen

API Referenz

Integrieren Sie ORRIX Dienstleistungen in Ihre Anwendungen mit unserer REST API.

API-Schlüssel

Generieren Sie API-Schlüssel in Ihrem Kundenbereich unter Einstellungen → API.

x-api-key: ••••••••••••••••

Rate Limits

Anfragen pro Zeitfenster, um faire Nutzung zu gewährleisten.

Standard: 1000 / Stunde
Enterprise: 10000 / Stunde

API Version

Aktuelle stabile API-Version mit allen Features.

v1.0 Stable
Authentifizierung

API-Zugriff authentifizieren

API-Key Authentifizierung

Alle API-Anfragen erfordern einen gültigen API-Schlüssel im Header. Generieren Sie Ihren API-Schlüssel im Kundenbereich.

Header
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Hinweis

Bewahren Sie Ihren API-Schlüssel sicher auf. Teilen Sie ihn niemals öffentlich oder in Client-Code.

Endpunkte

Verfügbare API-Endpunkte

Basis-URL

https://api.orrix.ch/v1
Code-Beispiele

Integration Beispiele

PHP

JavaScript (Fetch)

const API_KEY = 'YOUR_API_KEY';
const BASE_URL = 'https://api.orrix.ch/v1';

// Domains abrufen
async function getDomains() {
    try {
        const response = await fetch(`${BASE_URL}/domains`, {
            method: 'GET',
            headers: {
                'Authorization': `Bearer ${API_KEY}`,
                'Content-Type': 'application/json',
                'Accept': 'application/json'
            }
        });

        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }

        const data = await response.json();
        return data;
    } catch (error) {
        console.error('API Error:', error);
    }
}

// Verwendung
getDomains().then(data => {
    console.log('Domains:', data);
});

Python

import requests

API_KEY = 'YOUR_API_KEY'
BASE_URL = 'https://api.orrix.ch/v1'

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json',
    'Accept': 'application/json'
}

# Domains abrufen
response = requests.get(f'{BASE_URL}/domains', headers=headers)

if response.status_code == 200:
    domains = response.json()
    for domain in domains['data']:
        print(domain['name'])
else:
    print(f'Error: {response.status_code}')
    print(response.json())

cURL

curl -X GET "https://api.orrix.ch/v1/domains" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"
Fehlerbehandlung

HTTP Status Codes

Code Bedeutung Beschreibung
200 OK Anfrage erfolgreich verarbeitet
201 Created Ressource erfolgreich erstellt
400 Bad Request Ungültige Anfrage oder Parameter
401 Unauthorized API-Schlüssel fehlt oder ungültig
403 Forbidden Keine Berechtigung für diese Aktion
404 Not Found Ressource nicht gefunden
429 Too Many Requests Rate Limit überschritten
500 Internal Server Error Serverfehler - bitte später erneut versuchen

API-Schlüssel generieren

Loggen Sie sich in Ihren Kundenbereich ein, um API-Schlüssel zu verwalten.