DokumentationProdukteShellBaseMitglieder-APIMitglieder-API V1
Mitglieder einladen
In API Explorer austestenÖffnet den Explorer mit Methode und Pfad dieses Requests.
Lädt Adressen ins Team ein.
Derselbe Weg wie in der Anwendung: dieselbe Mail, derselbe Code, dieselbe Prüfung der Sitzplätze. Wer schon im Team ist, wird übersprungen statt abgewiesen.
POST https://members.api.shellbase.artim-industries.com/v1/invites
| Methode | POST |
| Basis | members.api.shellbase.artim-industries.com/v1 |
| Scope | sb.members.invites:write |
| Antwort | 201 |
| Zugang | Developer Mitgliedschaft |
| Auth | Authorization: Bearer sbapi_… |
Parameter
Dieser Endpunkt nimmt keine Parameter.
Anfragekörper
| Feld | Typ | Bedeutung |
|---|---|---|
emails | array | Die Adressen. Pflicht. |
Felder, die der Vertrag nicht nennt, werden verworfen — ein Client kann keine eigenen Felder unterschieben.
{ "emails": ["[email protected]", "[email protected]"] }
Anfrage
curl -X POST "https://members.api.shellbase.artim-industries.com/v1/invites" \
-H "Authorization: Bearer sbapi_…" \
-H "Content-Type: application/json" \
-d '{ "emails": ["[email protected]", "[email protected]"] }'
Antwort
| Feld | Typ | Bedeutung |
|---|---|---|
invited | array | Adressen, die eine Einladung bekommen haben. |
skipped | array | Adressen, die schon im Team sind. |
seatsLeft | integer | Wie viele Sitzplätze danach frei sind. |
{ "invited": ["[email protected]"], "skipped": ["[email protected]"], "seatsLeft": 4 }
Fehler
| Status | code | Wann |
|---|---|---|
400 | invalid_request | Ein Pflichtfeld fehlt, ein Typ passt nicht, oder ein Verweis zeigt auf etwas, das es hier nicht gibt. |
401 | invalid_token | Bearer fehlt, ist unbekannt oder abgelaufen. |
403 | missing_scope | Das Token trägt den Scope dieses Endpunkts nicht. |
404 | not_found | Der Eintrag gehört nicht zum freigegebenen Team — oder die Anfrage kam auf der falschen Subdomain an. |
409 | conflict | Der Zustand verbietet die Änderung — der Fehlerkörper nennt den Grund. |
429 | rate_limited | Kontingent erschöpft, siehe Retry-After. |
Jede Fehlerantwort trägt dieselbe Hülle: error.code benennt den Fehler, error.message sagt in einem Satz, was fehlt.
Rate Limits
Das Limit gilt pro Team, nicht pro Token.
| Zugang | Produktion | Sandbox |
|---|---|---|
| Hobby | 60 Anfragen/Minute | ohne Limit |
| Developer Mitgliedschaft | 10.000 Anfragen/Minute | ohne Limit |
Bei 429 sagt der Retry-After-Header, wie lange du warten sollst.