Integrations-API

Die API verfügt über eine öffentliche API (je Mandant) und eine private API für Authentifizierte Benutzer.

Authentifizierung der User-API

Benötigter oAuth2 scope: ameise.integrations

Der Access-Token wird im Authorization-Header übergeben:

Authorization: Bearer [Access-Token]

ServiceAccount unterstützung

Version
v1	Nein

URL

Produktiv-System:

https://integrations.ameiseapis.com/api/v1

Test-System:

https://integrations-ameiseapis.inte.dionera.dev/api/v1

Open API Spec

Für weitere Details der APIs kann die aktuallste version der Open API Spezifikation hier eingesehen werden:

https://gitlab.dionera.com/ameiseapis/ameiseapis/-/blob/main/integrations/openapi.yaml

Integrations scope

Zur Auflistung der Integrationen muss mind. ein scope mit gegeben werden, mögliche werte sind:

scope	Beschreibung
global	Diese Integrationen können in jeder Applikation zB. im Header aufgelistet werden

Verwendung der Icons

Icons können über drei möglichkeiten Eingebunden werden.

Icon-Set im DOM

Das iconSet kann in den DOM eingebunden werden und in weiteren SVG's referenziert werden:

<style>
    .icons-integrations {
        display: none;
    }
</style>
<svg width="40" height="40" viewBox="0 0 40 40" fill="none" xmlns="http://www.w3.org/2000/svg"  xmlns:xlink="http://www.w3.org/1999/xlink" class="icons-integrations">
    <symbol id="8a9198d6-174c-423e-885a-e76a717f942c" [..]><!-- [...] --></symbol>
    <!-- [...] -->
</svg>

<svg viewBox="0 0 40 40" xmlns="http://www.w3.org/2000/svg"  xmlns:xlink="http://www.w3.org/1999/xlink">
    <use xlink:href="#8a9198d6-174c-423e-885a-e76a717f942c" />
</svg>

Icon-Set im Image

Es kann auf ein icon im iconSet über die url referenziert werden:

<!-- note that the id starts with `icon-*` -->
<img src="path/to/iconset.svg#icon-8a9198d6-174c-423e-885a-e76a717f942c" alt="*" />

Jedes Icon einzeln

Jede integration liefert ausserdem eine URL zum abrufen des eigenen icons:

<img src="path/to/icons/8a9198d6-174c-423e-885a-e76a717f942c.svg" alt="*" />