Seamless API
Binden Sie Seamless in Ihre eigenen Systeme ein.
Mit der Seamless REST API binden Sie Seamless in Ihre eigenen Systeme ein. Ein Projektportal oder ein ERP erstellt dann z.B. für jedes neue Projekt automatisch einen Arbeitsraum, mit denselben Vorlagen, Namen und Regeln wie in der Seamless App.
Grundlagen
Abschnitt betitelt „Grundlagen“| Thema | Angabe |
|---|---|
| Base URL | https://sml-api.io |
| Format | JSON |
| Anmeldung | Bearer Token im Header Authorization, 24 Stunden gültig |
Authorization: Bearer eyJ0eXAiOiJKV1Qi...Das Token erhalten Sie mit einem API Key, siehe Access Token abrufen.
Identifier statt IDs
Abschnitt betitelt „Identifier statt IDs“Statt mit IDs sprechen Sie Organisationen und Vorlagen auch mit ihrem Identifier an. Das ist ein lesbarer Kurzname (Slug), z.B. contoso für die Organisation oder prj für die Vorlage. Sie erfassen ihn im Admin Center bei der Organisation und im Tab General der Vorlage.
Das vereinfacht die Integration, wenn es viele Organisationen mit denselben Vorlagen gibt. Erfassen Sie z.B. die Projektvorlage in allen Organisationen mit prj, wählt das aufrufende System nur noch die Organisation. Die Vorlage ist immer prj.
| organisationIdOrIdentifier | templateIdOrIdentifier |
|---|---|
finance |
prj |
marketing |
prj |
it |
prj |
Beispiele
Abschnitt betitelt „Beispiele“Alle Beispiele gibt es für cURL, PowerShell und C#. Die gewählte Sprache gilt auf allen Seiten.
- cURL: Das Token steht in
$TOKEN. - PowerShell: Der Header steht in
$headers, siehe Access Token abrufen. - C#:
httpist einHttpClientmit Base URL und Token, siehe Access Token abrufen.
In den Beispielen erstellen wir in der Organisation Contoso mit der Vorlage Projekt den Arbeitsraum 260215.001 - Projekt Atlas.
Endpunkte
Abschnitt betitelt „Endpunkte“| Endpunkt | Wofür |
|---|---|
POST /token |
Access Token abrufen |
GET /organisations |
Alle Organisationen auflisten |
GET /organisations/{idOrIdentifier} |
Organisation mit Vorlagen abrufen |
POST /teams |
Arbeitsraum aus einer Vorlage erstellen |
PATCH /teams/{teamId}/name |
Arbeitsraum umbenennen |
Wie die Endpunkte zusammenspielen, zeigt der Guide Projekt Arbeitsraum.