Organisation

2 endpoints

Les descriptions des endpoints proviennent directement de l'API et sont en allemand.

Organisation abrufen

get/v1/organization

Einstellungen der Organisation dieses API-Schlüssels: Name, Subdomain der Instanz, MWST, Branding, Testmodus.

Réponse 200Organization

Nom	Type	Description
`id`obligatoire	string	ID mit Präfix «org_»
`object`obligatoire	"organization"
`name`obligatoire	string
`slug`obligatoire	string	Subdomain der Instanz
`instance_url`obligatoire	string
`test_mode`obligatoire	boolean	Testmodus mit simulierten Ladepunkten und Testzahlungen
`vat_registered`obligatoire	boolean
`vat_number`obligatoire	string \| null
`vat_rate_bps`obligatoire	integer	MWST-Satz in Basispunkten (810 = 8.1 %)
`accent_color`obligatoire	string \| null

Erreurs possibles

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Exemple

curl -X GET https://api.ladehase.com/v1/organization \n  -H "Authorization: Bearer lh_test_…"

Réponse 200

{
  "id": "org_9c1f0b7a2e3d4c5b",
  "object": "organization",
  "name": "Hof Meier",
  "slug": "hof-meier",
  "instance_url": "https://hof-meier.ladehase.com",
  "test_mode": true,
  "vat_registered": true,
  "vat_number": "string",
  "vat_rate_bps": 0,
  "accent_color": "string"
}

Organisation ändern

patch/v1/organization

Ändert Name, Subdomain (alte Subdomain bleibt als Weiterleitung), Adresse, MWST, Akzentfarbe, Bedingungen für Fahrende oder Sichtbarkeit der Instanzseite.

Requête

Nom	Type	Description
`name`facultatif	string
`slug`facultatif	string
`legal_name`facultatif	string \| null
`street`facultatif	string \| null
`postal_code`facultatif	string \| null
`city`facultatif	string \| null
`country`facultatif	string
`contact_email`facultatif	string \| null
`contact_phone`facultatif	string \| null
`website`facultatif	string \| null
`vat_registered`facultatif	boolean
`vat_number`facultatif	string \| null
`vat_rate_bps`facultatif	integer
`accent_color`facultatif	string \| null
`logo_url`facultatif	string \| null
`welcome_text`facultatif	object \| null
`driver_terms`facultatif	object \| null
`public_page`facultatif	object
`test_mode`facultatif	boolean

Réponse 200Organization

Nom	Type	Description
`id`obligatoire	string	ID mit Präfix «org_»
`object`obligatoire	"organization"
`name`obligatoire	string
`slug`obligatoire	string	Subdomain der Instanz
`instance_url`obligatoire	string
`test_mode`obligatoire	boolean	Testmodus mit simulierten Ladepunkten und Testzahlungen
`vat_registered`obligatoire	boolean
`vat_number`obligatoire	string \| null
`vat_rate_bps`obligatoire	integer	MWST-Satz in Basispunkten (810 = 8.1 %)
`accent_color`obligatoire	string \| null

Erreurs possibles

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Exemple

curl -X PATCH https://api.ladehase.com/v1/organization \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","slug":"string","legal_name":"string","street":"string","postal_code":"string","city":"string","country":"string","contact_email":"person@example.ch","contact_phone":"string","website":"https://example.ch/webhooks/ladehase","vat_registered":true,"vat_number":"string","vat_rate_bps":0,"accent_color":"string","logo_url":"https://example.ch/webhooks/ladehase","welcome_text":{"de":"string","fr":"string","it":"string","en":"string"},"driver_terms":{"de":"string","fr":"string","it":"string","en":"string"},"public_page":{"showLocations":true,"showTariffs":true,"showMap":true,"showContact":true,"showOpeningHours":true},"test_mode":true}'

Réponse 200

{
  "id": "org_9c1f0b7a2e3d4c5b",
  "object": "organization",
  "name": "Hof Meier",
  "slug": "hof-meier",
  "instance_url": "https://hof-meier.ladehase.com",
  "test_mode": true,
  "vat_registered": true,
  "vat_number": "string",
  "vat_rate_bps": 0,
  "accent_color": "string"
}