Häufig gestellte Fragen

Unsere APIs verwenden

Ich möchte einfach eine API verwenden? Was sind Pläne?

Ein Plan ist eine Sammlung von API-Ressourcen oder Untergruppen von Ressourcen von einer oder mehreren APIs. Ein Plan kann eine Mischung aus Operationstypen aus verschiedenen APIs enthalten. Für einen Plan kann eine allgemeine Ratenbegrenzung für alle Ressourcen gelten oder für jede einzelne Ressource eine unterschiedliche Ratenbegrenzung. Ratenbegrenzungen geben an, wie viele Anforderungen für eine Anwendung während eines angegebenen Zeitintervalls zulässig sind.

Verwenden Sie dieses Developer Portal, um die verschiedenen Pläne zu durchsuchen, die für Sie verfügbar sind, und wählen Sie einen Plan aus, der Ihren Anforderungen am besten entspricht. Für einige Pläne ist der Zugriff eingeschränkt, sodass Sie für die Verwendung den Zugriff anfordern müssen. Wenn Sie Ihre Anforderung übergeben, wird die Organisation benachrichtigt, der API-Administrator bewertet Ihre Anforderung und kontaktiert Sie möglicherweise für weitere Details. Ändere Pläne sind für eine sofortige Verwendung verfügbar.

Wie kann ich meine API-Nutzung anzeigen?

Die Anzahl an Anforderungen für verschiedene APIs, die Ihre Anwendung gemacht hat, werden auf Ihrer Anwendungsseite angezeigt.

Klicken Sie im Hauptmenü auf 'Apps' und klicken Sie dann auf Ihre Anwendung. In der Tabelle 'Produktabonnements' werden alle Pläne angezeigt, die Ihre Anwendung abonniert hat.

Sie können für jede API, die in dem Plan enthalten ist, die Nutzung im Vergleich zur Ratenbegrenzung des Plans anzeigen.

Wie kann ich eine API testen?

Es ist möglich, eine API in diesem Developer Portal zu testen.

Wenn Sie die Details einer API anzeigen, sehen Sie eine Liste der Operationen, die in der API enthalten sind. Dies zeigt das Verb und den Pfad an, die für den Vorgang zu verwenden sind.

Wenn Sie auf die Operation klicken, werden weitere Informationen zur Ressource angezeigt, welche Parameter sie annehmen kann, was sie zurückgibt, welche möglichen Rückgabecodes sie verwenden kann und was diese bedeuten.

Es gibt auch eine Schaltfläche 'Versuchen' für REST-APIs, mit der Sie die Operation direkt im Developer Portal testen können.

Wenn für die API eine Client-ID oder ein geheimer Clientschlüssel für die Identifikation erforderlich ist, können Sie diese mithilfe Ihrer Anwendungsberechtigungsnachweise oben im Abschnitt 'Versuchen' angeben.

Apps

Wie registriere ich eine Anwendung?

Wenn Sie eine Anwendung hinzufügen, erhalten Sie einen API-Schlüssel und einen geheimen Schlüssel für die Anwendung. Sie müssen diese Berechtigungsnachweise angeben, wenn Sie eine API aufrufen, für die eine Authentifizierung Ihrer Anwendung erforderlich ist.

Um eine Anwendung zu registrieren, klicken Sie im Hauptmenü auf 'Apps' und klicken Sie dann auf den Link 'Neue App erstellen'. Nachdem Sie einen Anwendungsnamen, eine Beschreibung usw. angegeben haben, werden Ihr Anwendungs-API-Schlüssel sowie der geheime Schlüssel angezeigt.

Notieren Sie sich Ihren geheimen Clientschlüssel, da er nur ein Mal angezeigt wird.

Wie kann ich meinen geheimen Anwendungs-API-Schlüssel zurücksetzen?

Ihr geheimer API-Schlüssel wird verschlüsselt gespeichert, sodass wir die unverschlüsselte Version nicht abrufen können, um Ihnen den Wert mitzuteilen, wenn Sie ihn vergessen haben.

Sie können den Schlüssel zurücksetzen, dadurch wird der gespeicherte Wert aktualisiert und der neue Wert an Sie zurückgegeben.

Klicken Sie dafür im Hauptmenü auf 'Apps', klicken Sie auf die betreffende Anwendung und klicken Sie dann auf den Link 'Zurücksetzen' im Abschnitt 'Geheimer API-Schlüssel'.

Ihr neuer geheimer Schlüssel wird oben auf der Seite angezeigt.