Die Schnittstelle: Client-Id und API-Key

Photovate hat eine Schnittstelle, über die andere Systeme Kontakte, Chancen, Angebote und Artikel lesen und schreiben können. Für den Zugang gibt es zwei Werte: eine „Client-Id" und einen „API-Key".

Dieser Artikel richtet sich an alle, die ein Fremdsystem anbinden sollen. Er sagt, wo die beiden Werte stehen, wofür sie da sind und warum du in der Oberfläche nichts findest, was „V3" heißt.

Zur Benennung: Der Begriff „V3 API Key" kommt in Photovate nirgends vor — weder in einem Menü noch in einem Feld. Gemeint ist damit der „API-Key", der unten beschrieben wird: Es gibt nur einen. Die „3" stammt aus einer Kennung, die intern im Schlüssel steckt und die du nie zu sehen bekommst. Such also nicht nach „V3", sondern nach dem Abschnitt „Deine Zugangsdaten für Reonic".

Wo die beiden Werte stehen

Sie werden im Einrichtungsfenster der Reonic-Anbindung angezeigt — auch dann, wenn du Reonic gar nicht nutzt. Einen eigenen Menüpunkt dafür gibt es nicht.

Gehe auf „Einstellungen" → „Integrationen", klicke in der Zeile „Reonic" auf „Integration aktivieren" beziehungsweise „Konfigurieren". Im Fenster findest du unten den Abschnitt „Deine Zugangsdaten für Reonic" mit:

  • „Client-Id" — sofort lesbar
  • „API-Key" — verdeckt, über den Augen-Umschalter sichtbar

Beide Felder sind schreibgeschützt und haben rechts einen Kopier-Knopf mit dem Hinweis „In die Zwischenablage kopieren".

Bitte beachten: Der Abschnitt wird dir nur angezeigt, wenn deine Rolle Leserechte auf Mitarbeiter hat. Fehlt der Abschnitt, liegt es daran — nicht daran, dass keine Zugangsdaten existieren.

Wofür die Werte da sind

Beide entstehen automatisch, sobald euer Betrieb eingerichtet wird. Du musst sie nirgends beantragen und kannst sie auch nicht selbst erzeugen.

WertWofür
„Client-Id"steht in der Adresse der Schnittstelle und sagt, um welchen Betrieb es geht
„API-Key"weist den Aufruf als berechtigt aus

Über die Schnittstelle lassen sich Kontakte, Chancen, Angebote und Artikel abrufen; Kontakte, Chancen und Angebote können auch angelegt und aktualisiert werden.

Gut zu wissen: Der „API-Key" ist ein Zugangsschlüssel für euren gesamten Betrieb. Er gehört nicht in eine E-Mail, nicht in einen Chat und nicht in ein Ticket. Gib ihn nur an die Person oder das System weiter, das die Anbindung tatsächlich betreibt.

Verwechslungsgefahr

In Photovate gibt es mehrere Felder, die ähnlich heißen. Das ist die häufigste Rückfrage:

FeldRichtungGehört zu
„API-Key" unter „Deine Zugangsdaten für Reonic"aus Photovate herauseurer Schnittstelle
„Reonic API-Key" im selben Fensternach Photovate hineineurem Zugang bei Reonic
„API-Key" im PV-Secure-Fensternach Photovate hineineurem Zugang bei PV Secure

Nur der erste gehört euch. Die anderen beiden bekommt ihr vom jeweiligen Anbieter und tragt sie ein.

Wenn es nicht klappt

Ich finde nichts, was „V3" heißt. Richtig — das Wort kommt im Produkt nicht vor. Gemeint ist der „API-Key" aus dem Abschnitt „Deine Zugangsdaten für Reonic".

Der Abschnitt „Deine Zugangsdaten für Reonic" fehlt. Deiner Rolle fehlen die Leserechte auf Mitarbeiter. Wende dich an die Person, die eure Berechtigungen betreut.

Der Aufruf wird abgewiesen. Prüfe, ob „Client-Id" und „API-Key" aus demselben Fenster stammen und vollständig kopiert wurden — der „API-Key" ist lang und muss vollständig übernommen werden. Passen beide nicht zusammen oder ist der Zugang abgeschaltet, antwortet die Schnittstelle mit „Client mismatch or inactive".

Ich möchte den Schlüssel zurücksetzen. Dafür gibt es in der Oberfläche keinen Knopf. Wende dich an den Support.

War dieser Artikel hilfreich?

Das ist großartig!

Vielen Dank für das Feedback

Leider konnten wir nicht helfen

Vielen Dank für das Feedback

Wie können wir diesen Artikel verbessern?

Wählen Sie wenigstens einen der Gründe aus
CAPTCHA-Verifikation ist erforderlich.

Feedback gesendet

Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren