Möchten Sie wissen, wie unsere APIs funktionieren, welche Daten für ein Unternehmen oder eine Immobilie verfügbar sind und möchten Sie keinen Entwickler-Support in Anspruch nehmen? Kein Problem, folgen Sie unserem Leitfaden und Sie können unsere API in Sekundenschnelle testen. Auch wenn Sie keine Ahnung von Code haben!

Die Funktion, die Ihnen dabei helfen wird, heißt "Try It Out" und ist im Konsolenbereich unter allen Endpoint verfügbar.

Registrieren Sie sich zuerst!

Um unsere API nutzen zu können, müssen Sie sich zunächst registrieren, sofern Sie dies noch nicht getan haben.

 

Sobald Sie Ihre Registrierung abgeschlossen haben, loggen Sie sich ein und gehen Sie, falls Sie noch nicht dort sind, zum Portal Console, wo Sie die technische Dokumentation für die Integration unserer API und die Funktion Try It Out zum Testen der API finden.

Auswählen, API aktivieren und Token erstellen

Um loszulegen, sind die wichtigsten Schritte wie folgt:

1) Wählen Sie die API, die Sie interessiert, im Abschnitt Bibliothek aus (um Ihre Suche zu beschleunigen, können Sie APIs nach Kategorien filtern)

2) Aktivieren Sie die API, indem Sie auf die Schaltfläche Aktivieren klicken und die Anweisungen befolgen

Bei einigen Diensten werden Sie möglicherweise aufgefordert, eine Zwei-Faktor-Authentifizierung durchzuführen oder eine ID einzugeben (sobald die erste API aktiviert ist, müssen Sie bei den meisten anderen nur noch auf "Aktivieren" klicken, um sie betriebsbereit zu machen)

3) Erstellen Sie das Token, um sich zu authentifizieren

Wenn die API, die Sie suchen, keine kostenlosen Anrufe vorsieht, sollten Sie Ihr Guthaben aufladen, bevor Sie fortfahren.

Wenn Sie sich hingegen vergewissert haben, dass die gewünschte API kostenlose Anrufe ermöglicht, können Sie direkt mit der Erstellung Ihres ersten Tokens beginnen, einer Art Passwort, das Sie benötigen, um sich zu authentifizieren und die API sicher zu nutzen.

Um Ihr erstes Token zu erstellen, können Sie

• das spezielle Tool Neues Token (Sandbox) im Abschnitt Authentifizierung

 

• den Post/Token-Endpoint der Oauth-API. In diesem Fall müssen Sie die APIKey Sandbox verwenden, die im Abschnitt Authentifizierung verfügbar ist

 

Kopieren Sie das Token, eine Reihe von alphanumerischen Zeichen, die Sie erzeugt haben, da Sie es bald verwenden müssen.

Sie sind bereit für Ihren ersten Aufruf

Wir werden die API von Company als Beispiel für unseren ersten Aufruf verwenden, insbesondere den Endpoint GET/IT-advanced/{vatCode_taxCode_or_id}, der einer der am häufigsten verwendeten ist und "synchron" ist, d. h. er liefert Ergebnisse in Echtzeit.

Company Advanced VAT number ermöglicht es, anhand eines Parameters (z. B. der Umsatzsteuer-Identifikationsnummer) eine Reihe von Informationen über das Unternehmen zu erhalten, wie z. B. die Adresse des eingetragenen Sitzes, die PEC, den Umsatz und den Gewinn der letzten drei Jahre sowie die Anzahl der Beschäftigten. Andere Endpoint könnten nach den Katasterdaten einer Immobilie oder der Steuernummer einer Person fragen.

Vergewissern Sie sich, dass der Server auf Produktion (und nicht auf Sandbox) eingestellt ist, um die echten Daten zu erhalten und nicht die Testumgebung zu verwenden.

 

Nun ist es an der Zeit, das von uns erstellte Token zu verwenden und mit der Authentifizierung fortzufahren. Klicken Sie auf die Schaltfläche Authorize und geben Sie in das Feld Value das Token ein, dann klicken Sie auf Close.

 

Nachdem Sie das Authentifizierungsverfahren abgeschlossen haben, klicken Sie auf den gewünschten Endpoint (/IT-advanced/{vatCode_taxCode_or_id}) und der entsprechende Abschnitt wird geöffnet.

Auf der rechten Seite wird die Schaltfläche Try it out sichtbar, über die Sie den Aufruf testen können.

Die Suchparameter für Get Company Advanced Vat number, Steuernummer oder ID. Wir verwenden die Umsatzsteuer-Identifikationsnummer, d. h. die Umsatzsteuer-Identifikationsnummer des zu prüfenden Unternehmens.

Geben Sie dann die Umsatzsteuernummer ein und klicken Sie auf die Schaltfläche Execute.

 

Ihr Aufruf wurde gesendet, und wenn Sie nach unten zu Responses > Response Body, finden Sie die Antwort auf Ihre Anfrage mit allen verfügbaren Unternehmensdaten. Die Daten sind in Json strukturiert, einem einfachen, leicht lesbaren Datenaustauschformat.

Sind das die Daten, die Sie benötigen? Wenden Sie sich an Ihren Entwickler, um das Integrationsverfahren zu starten.

Haben Sie Zweifel an den Daten oder benötigen Sie andere Informationen und können diese nicht auf der Website finden? Zögern Sie nicht, uns zu kontaktieren, um herauszufinden, wie unsere API Ihrem Unternehmen helfen kann.