Hallo und herzlich willkommen zur Hirely API-Dokumentation! Wir freuen uns, dass du dich für unsere Dienstleistungen interessierst und bereit bist, die volle Power der Hirely Software durch unsere REST API zu entdecken.

Wie unsere API funktioniert

Unsere API folgt dem REST-Standard, was bedeutet, dass sie stateless ist und Ressourcen über URLs abruft. Du kannst dich darauf verlassen, dass unsere URL-Struktur konsistent und einfach zu verstehen ist, da sie ressourcenorientiert ist.

Unsere API akzeptiert Anfragen, die sowohl als form-encoded als auch als JSON formatiert sind, um deine bevorzugte Methode der Dateneingabe zu berücksichtigen. Im Gegenzug senden wir dir JSON-encoded Antworten, was dir die Datenverarbeitung erleichtert.

Wir verwenden HTTP-Antwortcodes, um den Status deiner Anfrage zu kommunizieren. Dabei folgen wir den allgemein anerkannten Standards: Codes im 2xx-Bereich zeigen an, dass deine Anfrage erfolgreich war, während Codes im 4xx-Bereich auf einen Fehler hinweisen, den du in deiner Anfrage beheben solltest. Solltest du jemals einen 5xx-Fehlercode erhalten, liegt dies an einem Problem auf unserer Seite, und wir werden es so schnell wie möglich beheben.

Authentifizierung

Für die Authentifizierung verwenden wir standardmäßige Methoden, um die Sicherheit deiner Daten zu gewährleisten. Wenn du spezielle Fragen zur Authentifizierung hast, zögere nicht, uns zu kontaktieren.

Rate-Limiting

Um eine faire Nutzung unserer API zu gewährleisten, begrenzen wir die Anzahl der Operationen pro Benutzerkonto auf 75 pro Minute. Bitte beachte, dass diese Beschränkung pro Benutzerkonto und nicht pro API-Schlüssel gilt.

Wenn du versuchst, mehr Anfragen zu senden, erhältst du einen HTTP-Statuscode 429. Solltest du ein höheres Limit benötigen, steht unser Support-Team zur Verfügung, um deine Anforderungen zu besprechen. Bitte kontaktiere uns unter [email protected], um eine Erhöhung deines Limits zu beantragen. Bei erheblichen Erhöhungen bitten wir dich, uns mindestens zwei Wochen im Voraus zu kontaktieren.

Fehlerbehandlung

Wie bereits erwähnt, verwenden wir HTTP-Antwortcodes, um dir den Status deiner Anfragen mitzuteilen.

In der Regel gelten:

• 2xx-Codes als Erfolgsmeldung
• 4xx-Codes weisen auf einen Fehler in deiner Anfrage hin
• 5xx-Codes bedeuten, dass es ein Problem auf unserer Seite gibt

Wir hoffen, dass diese Einführung hilfreich für dich war! Zögere nicht, uns zu kontaktieren, wenn du weitere Fragen hast. Viel Spaß beim Erkunden der Hirely API!