Was ist die öffentliche API von Agicap?

Die öffentliche API ermöglicht es Ihnen und Ihren Integratoren oder Partnern, technische Integrationen mit Agicap zu entwickeln. Sie erlaubt die Automatisierung des Datenaustauschs zwischen Anwendungen und ermöglicht eine nahtlose Integration mit Ihren bestehenden Tools.

Warum die öffentliche API nutzen?

Hier sind einige unmittelbare Vorteile der Nutzung der öffentlichen API:

Erhöhte Sicherheit: Unsere APIs sind durch einen Client-Credential-Flow geschützt. Jede Organisation muss ihre eigenen Anmeldeinformationen aus der Agicap-App generieren, bevor sie die API nutzen kann. Es ist sicherer, da jeder Dienst einzigartige Anmeldeinformationen verwendet.
Erhöhte Leistung: Unsere Lösung kann bis zu 4000 Anfragen pro Sekunde verarbeiten, sodass Ihre Integrationen skalieren können, ohne API-Ausfälle befürchten zu müssen.
Konsistenz: Wir haben Agicap API-Richtlinien definiert, um sicherzustellen, dass alle unsere freigelegten APIs standardisierte Implementierungen haben.

Langfristig wird die öffentliche API Anwendungsfälle ermöglichen, die mit unserer vorherigen Open API nicht möglich waren:

Umfassendes Monitoring: Überwachen Sie den API-Verbrauch durch konfigurierte Clients und deren Endpunkte.
Benutzer-Impersonationsfähigkeiten: Erlauben Sie API-Aufrufe als Benutzer innerhalb eines Client-Credential-Systems, um automatisierte Aufgaben wie das Zuweisen eines Benutzers zu einer Entität zu ermöglichen, wenn dieser zu Ihrem Active Directory hinzugefügt wird.

Wie man mit der öffentlichen API beginnt

1. Zugriff auf die öffentliche API-Dokumentation

Die Dokumentation zur öffentlichen API ist unter https://api.agicap.com/ verfügbar. Hier finden Sie detaillierte Informationen darüber, wie Sie API-Anfragen stellen können.

2. Generieren Sie Ihre API-Anmeldeinformationen

Nur Organisations-Admin-Benutzer können API-Schlüssel aus den Erweiterten Parametern in der Agicap-App generieren. Andere Benutzer können vorhandene Anmeldeinformationen anzeigen, aber keine neuen generieren oder vorhandene löschen.

Um API-Anmeldeinformationen zu generieren:

Navigieren Sie zu Erweiterte Parameter in Ihrem Agicap-Konto.
Wählen Sie API-Einstellungen.
Klicken Sie auf Neue Anmeldeinformationen generieren.
Hinweis: Aus Sicherheitsgründen wird das Client-Geheimnis nur einmal bei der Generierung angezeigt. Stellen Sie sicher, dass Sie es sicher aufbewahren.

👍 Es wird empfohlen, für jedes Tool, jeden Integrator oder Partner ein einzigartiges Set von API-Schlüsseln zu verwenden.

3. Authentifizieren Sie Ihre API-Anfragen

Die Authentifizierung erfolgt über API-Schlüssel und erfordert ein temporäres Zugriffstoken. Sie können dieses Token mit der Authentifizierungsanfrage und Ihren API-Schlüsseln abrufen.

Jede Anfrage muss dieses Zugriffstoken enthalten.

4. API-Anfragen stellen

API-Anfragen sind in Domänen und Produkte organisiert:

API-Domänen: Beziehen sich auf den allgemeinen Geschäftskontext.
API-Produkte: Beziehen sich auf spezifische Objekte oder Sätze verwandter Objekte, mit denen interagiert werden soll.

Die meisten Anfragen werden gestellt, um Daten für eine bestimmte Organisation oder Entität abzurufen.

Die Organisations-ID kann von der API-Einstellungsseite abgerufen werden.
Die Entitäts-ID kann über die List-Entities-Anfrage abgerufen werden.

Sie können:

Daten von Agicap abrufen, um Ihre Tools zu aktualisieren.
Daten in Agicap einfügen, aktualisieren oder löschen.

5. API-Endpunkte erkunden

Besuchen Sie https://api.agicap.com/apis, um die verfügbaren Endpunkte und Aktionen zu sehen, die Sie über die öffentliche API ausführen können.

💡 Tipps

Halten Sie Ihre Anmeldeinformationen sicher: Ihr Client-Geheimnis wird nur einmal angezeigt. Bewahren Sie es sicher auf.
Verwenden Sie einzigartige Anmeldeinformationen: Generieren Sie separate API-Schlüssel für jeden Dienst oder jede Integration für eine bessere Sicherheit.
Überprüfen Sie die Dokumentation: Konsultieren Sie immer https://api.agicap.com/ für die aktuellsten Informationen.

Q&A ❓

Was ist der Unterschied zwischen der öffentlichen API und der Open API?

Achten Sie darauf, Open API und öffentliche API nicht zu verwechseln; sie sind zwei verschiedene Dinge:

Open API: Ermöglicht die Erstellung von Geschäfts- und Bankverbindungen (meist über AFT) und wird vom Data Integration Team verwaltet. Endpunkte beginnen mit openapi.agicap.com.
Öffentliche API: Ermöglicht das sichere und effiziente Senden und Abrufen verschiedener Daten von Agicap. Endpunkte beginnen mit api.agicap.com.

Die öffentliche API bietet verbesserte Sicherheit, Leistung und neue Funktionen, die mit der Open API nicht verfügbar sind.

Wie migriere ich von der Open API zur öffentlichen API?

Unser Ziel ist es, alle Anwendungsfälle auf die öffentliche API zu übertragen. Wir werden Kunden, die noch die Open API verwenden, kontaktieren, sobald alle Anwendungsfälle auf der öffentlichen API abgedeckt sind.

Kann ich Unterstützung bei der Einrichtung der öffentlichen API erhalten?

Kunden sollen in der Lage sein, die öffentliche API eigenständig einzurichten, indem sie den Anweisungen auf der öffentlichen Website https://api.agicap.com/ folgen. Wenn Sie weitere Unterstützung benötigen, lassen Sie es uns bitte wissen.