API
Nubeto kann beliebig in andere Systeme integriert werden. Die API ist:
- Simpel
- Für alle Instanzen verfügbar
- HTTP basiert
Die Nubeto AD Integration verwendet im Hintergrund eine geplante Aufgabe, die standardmäßig alle 15 Minuten aufgerufen wird. Ein kürzeres Intervall wird nicht unterstützt. In großen Umgebungen kann es erforderlich sein, das Intervall zu erhöhen.
Grundlagen
Die Base URL der API lautet:
https://instanz.nubetoapp.com/api/v1/
Authentifizierung
Um sich an der API zu authentifizieren, reicht es aus, einen Baerer Token im Header zu übergeben:
Authorization: Bearer abcd123
Beispiele
Alle Accounts der jeweiligen Integration abrufen
GET https://instanz.nubetoapp.com/api/v1/accounts/all
Headers:
Authorization = Bearer abcd123
200 OK
[
{
"id": 11,
"employee_id": 53,
"account_type_id": 1,
"email": "maxim.schepel@example.com",
"created_at": "2022-05-26T08:44:36.000000Z",
"updated_at": "2022-05-26T08:44:36.000000Z",
"deleted_at": null,
"first_password": null,
"provider_account_id": null,
"user_principal_name": null,
"is_primary": 1,
"new_status": null,
"status": "provisioned",
"employee": {
"id": 53,
"organizational_unit_id": 18,
"organizational_role_id": 5,
"firstname": "Maxim",
"lastname": "Schepel",
"salutation": "Herr",
"title": null,
"datev_id": 124,
"birthdate": "1990-07-20",
"personnel_number": 13075,
"start_of_contract": "2019-06-01",
"end_of_contract": null,
"job_title": "Erzieher",
"phone_number_mobile": null,
"phone_number": null,
"comment": null,
"status": "0",
"created_at": "2022-05-26T08:44:36.000000Z",
"updated_at": "2022-05-26T08:44:36.000000Z",
"deleted_at": null,
"global_roles": "",
"organizational_unit": "@{id=18; address_id=27; name=Leipzig Kita; number=1116; created_at=2022-05-26T08:44:30.000000Z; updated_at=2022-05-26T08:44:30.000000Z; deleted_at=}",
"organizational_role": "@{id=5; name=Mitglied; manager=0; created_at=2022-09-27T05:51:31.000000Z; updated_at=2022-09-27T05:51:31.000000Z; deleted_at=}",
"organizational_units": "",
"feature_roles": ""
},
"account_type": {
"id": 1,
"name": "Schule",
"created_at": "2022-05-26T08:44:28.000000Z",
"updated_at": "2022-11-24T05:44:10.000000Z",
"deleted_at": null,
"integration_id": 2,
"email_scheme_id": 3,
"domain_scheme": "example.com",
"notification_type_id": 2,
"email": "personal@example.com",
"display_name_suffix": null,
"notification_role_id": 1,
"mail_template_id": 1
}
},
{
"id": 12,
"employee_id": 54,
"account_type_id": 1,
"email": "marie.eimer@example.com",
"created_at": "2022-05-26T08:44:36.000000Z",
"updated_at": "2023-06-14T02:50:04.000000Z",
"deleted_at": null,
"first_password": null,
"provider_account_id": null,
"user_principal_name": null,
"is_primary": 1,
"new_status": "inactive",
"status": "provisioned",
"employee": {
"id": 54,
"organizational_unit_id": 37,
"organizational_role_id": 5,
"firstname": "Marie",
"lastname": "Eimer",
"salutation": null,
"title": null,
"datev_id": 111,
"birthdate": null,
"personnel_number": 13076,
"start_of_contract": "2019-07-01",
"end_of_contract": "2019-12-31",
"job_title": null,
"phone_number_mobile": null,
"phone_number": null,
"comment": null,
"status": "1",
"created_at": "2022-05-26T08:44:36.000000Z",
"updated_at": "2022-05-26T08:44:36.000000Z",
"deleted_at": null,
"global_roles": "",
"organizational_unit": "@{id=37; address_id=16; name=Halle Kita; number=1143; created_at=2022-05-26T08:44:31.000000Z; updated_at=2022-05-26T08:44:31.000000Z; deleted_at=}",
"organizational_role": "@{id=5; name=Mitglied; manager=0; created_at=2022-09-27T05:51:31.000000Z; updated_at=2022-09-27T05:51:31.000000Z; deleted_at=}",
"organizational_units": "",
"feature_roles": ""
},
"account_type": {
"id": 1,
"name": "Schule",
"created_at": "2022-05-26T08:44:28.000000Z",
"updated_at": "2022-11-24T05:44:10.000000Z",
"deleted_at": null,
"integration_id": 2,
"email_scheme_id": 3,
"domain_scheme": "example.com",
"notification_type_id": 2,
"email": "personal@example.com",
"display_name_suffix": null,
"notification_role_id": 1,
"mail_template_id": 1
}
},
{
"id": 15,
"employee_id": 66,
"account_type_id": 1,
"email": "emily.schmidt@example.com",
"created_at": "2022-05-26T08:44:37.000000Z",
"updated_at": "2023-06-14T02:50:04.000000Z",
"deleted_at": null,
"first_password": null,
"provider_account_id": null,
"user_principal_name": null,
"is_primary": 1,
"new_status": "inactive",
"status": "provisioned",
"employee": {
"id": 66,
"organizational_unit_id": 29,
"organizational_role_id": 5,
"firstname": "Emily",
"lastname": "Schmidt",
"salutation": null,
"title": null,
"datev_id": 123,
"birthdate": null,
"personnel_number": 13089,
"start_of_contract": "2016-08-01",
"end_of_contract": "2019-12-31",
"job_title": null,
"phone_number_mobile": null,
"phone_number": null,
"comment": null,
"status": "1",
"created_at": "2022-05-26T08:44:37.000000Z",
"updated_at": "2022-05-26T08:44:37.000000Z",
"deleted_at": null,
"global_roles": "",
"organizational_unit": "@{id=29; address_id=9; name=Fürstenwalde Grundschule; number=1127; created_at=2022-05-26T08:44:31.000000Z; updated_at=2022-05-26T08:44:31.000000Z; deleted_at=}",
"organizational_role": "@{id=5; name=Mitglied; manager=0; created_at=2022-09-27T05:51:31.000000Z; updated_at=2022-09-27T05:51:31.000000Z; deleted_at=}",
"organizational_units": "",
"feature_roles": ""
},
"account_type": {
"id": 1,
"name": "Schule",
"created_at": "2022-05-26T08:44:28.000000Z",
"updated_at": "2022-11-24T05:44:10.000000Z",
"deleted_at": null,
"integration_id": 2,
"email_scheme_id": 3,
"domain_scheme": "example.com",
"notification_type_id": 2,
"email": "personal@example.com",
"display_name_suffix": null,
"notification_role_id": 1,
"mail_template_id": 1
}
}
]