64 lines
1.4 KiB
Markdown
64 lines
1.4 KiB
Markdown
# Integrations
|
|
|
|
The dd can be integrated with other systems using their APIs.
|
|
|
|
## Autentication
|
|
|
|
All requests must be authenticated with a [Json Web Token (JWT)][jwt],
|
|
and must be signed with the `API_SECRET` (defined in `dd.conf`).
|
|
|
|
This authentication is done with the `Authentication` http header.
|
|
|
|
<details>
|
|
<summary>Read details</summary>
|
|
```sh
|
|
> curl -H "Authorization: bearer ${jwt}" https://admin.DOMAIN/ddapi/roles
|
|
[
|
|
{
|
|
"keycloak_id": "9325ad99-7e04-4c31-9768-5512e1564160",
|
|
"id": "admin",
|
|
"name": "admin",
|
|
"description": "${role_admin}"
|
|
},
|
|
{
|
|
"keycloak_id": "c6c8a73e-51fc-4716-831d-1dfc0e0b62b0",
|
|
"id": "manager",
|
|
"name": "manager",
|
|
"description": "Realm managers"
|
|
},
|
|
{
|
|
"keycloak_id": "24d7977e-da83-4591-8e13-0fac3126afa1",
|
|
"id": "student",
|
|
"name": "student",
|
|
"description": "Realm students"
|
|
},
|
|
{
|
|
"keycloak_id": "d6699c41-13d5-4623-bdca-e5f2775474ed",
|
|
"id": "teacher",
|
|
"name": "teacher",
|
|
"description": "Realm teachers"
|
|
}
|
|
]
|
|
```
|
|
|
|
Where <code>JWT</code> can be generated, e.g. using <code>python-jose</code>:
|
|
|
|
```python
|
|
import os
|
|
from jose import jws
|
|
t = jws.sign({}, os.environ["API_SECRET"], algorithm="HS256")
|
|
print(t)
|
|
```
|
|
|
|
Other programming languages have similar ways of generating tokens.
|
|
</details>
|
|
|
|
[jwt]: https://jwt.io/
|
|
[jose]: https://python-jose.readthedocs.io/
|
|
|
|
## API Notable
|
|
|
|
|
|
|
|
!!swagger ddapi.json!!
|