API-Referenz

Vollständige API-Dokumentation mit Beispielen, Endpunkten und Code-Snippets zur Integration mit TechRam-Diensten.

Bald Verfügbar: Unsere umfassende API-Dokumentation befindet sich derzeit in der Entwicklung. Wir werden unsere vollständige API so schnell wie möglich bereitstellen. Bleiben Sie dran für Updates!

1. Einführung

Die TechRam API ermöglicht es Entwicklern, TechRam-Dienste in ihre Anwendungen zu integrieren. Unsere RESTful API bietet programmatischen Zugriff auf TechRam-Funktionalität, sodass Sie benutzerdefinierte Integrationen erstellen und Workflows automatisieren können.

Diese Dokumentation behandelt Authentifizierung, Endpunkte, Anfrage-/Antwortformate, Fehlerbehandlung und Best Practices für die Verwendung der TechRam API.

2. Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mit API-Schlüsseln. Fügen Sie Ihren API-Schlüssel in die Anfrage-Header ein:

Authorization: Bearer YOUR_API_KEY

API-Schlüssel können aus Ihrem TechRam-Konto-Dashboard generiert werden. Halten Sie Ihre API-Schlüssel sicher und geben Sie sie niemals in clientseitigem Code oder öffentlichen Repositories preis.

3. Basis-URL

Alle API-Anfragen sollten an die folgende Basis-URL gesendet werden:

https://api.techramllc.com/v1

Alle Endpunkte sind relativ zu dieser Basis-URL. Um beispielsweise auf den Projekte-Endpunkt zuzugreifen, würden Sie verwenden:

https://api.techramllc.com/v1/projects

4. API-Endpunkte

Die TechRam API bietet die folgenden Endpunkte:

Projekte

GET /projects

Abrufen einer Liste aller mit Ihrem Konto verknüpften Projekte.

Projekt Erstellen

POST /projects

Erstellen Sie ein neues Projekt. Erforderliche Parameter:

Parameter	Typ	Erforderlich	Beschreibung
name	string	Ja	Projektname
description	string	Nein	Projektbeschreibung

5. Anfrage- und Antwortformat

Anfrageformat

Alle Anfragen sollten die folgenden Header enthalten:

                    Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
                

Anfragekörper sollten JSON-kodiert sein.

Antwortformat

Alle Antworten werden im JSON-Format zurückgegeben. Eine typische Erfolgsantwort:

                    {
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}
                

6. Fehlerbehandlung

Die API verwendet Standard-HTTP-Statuscodes, um Erfolg oder Fehler anzuzeigen:

200 OK: Anfrage erfolgreich
201 Created: Ressource erfolgreich erstellt
400 Bad Request: Ungültige Anfrageparameter
401 Unauthorized: Authentifizierung erforderlich oder ungültiger API-Schlüssel
404 Not Found: Ressource nicht gefunden
500 Server Error: Interner Serverfehler

Fehlerantworten enthalten ein Nachrichtenfeld mit Details darüber, was schief gelaufen ist.

7. Ratenbegrenzung

Um eine faire Nutzung zu gewährleisten, implementiert die API eine Ratenbegrenzung:

Standard-Pläne: 100 Anfragen pro Minute
Premium-Pläne: 500 Anfragen pro Minute
Unternehmens-Pläne: Benutzerdefinierte Limits

Ratenbegrenzungsinformationen sind in den Antwort-Headern enthalten. Wenn Sie das Limit überschreiten, erhalten Sie eine 429 Zu Viele Anfragen-Antwort.

8. Code-Beispiele

JavaScript-Beispiel

                    fetch('https://api.techramllc.com/v1/projects', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));
                

PHP-Beispiel

                    $ch = curl_init('https://api.techramllc.com/v1/projects');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer YOUR_API_KEY',
  'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
                

9. Support und Ressourcen

Für zusätzliche Hilfe und Ressourcen:

Benötigen Sie Hilfe? Unser Support-Team ist 24/7 verfügbar. Kontaktieren Sie uns unter info@techramllc.com für API-bezogene Fragen.