|
|
The service api provides access to general services provided by the Passwords app.
|
|
|
|
|
|
# Available api endpoints
|
|
|
| Action | Url | Method | Session required | Description |
|
|
|
|------------------------------------------------------|-------------------------------------------------------------|--------|------------------|------------------------------------------------------|
|
|
|
| [password](#the-password-endpoint) | `/api/1.0/service/password` | GET | yes | Generates a password with the users default settings |
|
|
|
| [password](#the-password-endpoint) | `/api/1.0/service/password` | POST | yes | Generates a password with the given settings |
|
|
|
| [avatar](#the-avatar-endpoint) | `/api/1.0/service/avatar/{user}/{size}` | GET | no | Returns the avatar image for a user |
|
|
|
| [favicon](#the-favicon-endpoint) | `/api/1.0/service/favicon/{domain}/{size}` | GET | no | Returns a favicon image for a domain |
|
|
|
| [preview](#the-preview-endpoint) | `/api/1.0/service/preview/{domain}/{view}/{width}/{height}` | GET | no | Returns a preview image for a domain |
|
|
|
| [hashes](./Service-API/Hashes-API) | `/service/hashes/{range}` | GET | no | Returns breached hashes for the given range |
|
|
|
| [password-change](#the-password-change-url-endpoint) | `/api/1.0/service/password-change` | POST | no | Returns the url of the password change page |
|
|
|
| Action | Url | Method | Session required | Description |
|
|
|
|------------------------------------------------------|-------------------------------------------------------------|------------|------------------|-------------------------------------------------------|
|
|
|
| [password](#the-password-endpoint) | `/api/1.0/service/password` | GET | yes | Generates a password with the users default settings |
|
|
|
| [password](#the-password-endpoint) | `/api/1.0/service/password` | POST | yes | Generates a password with the given settings |
|
|
|
| [avatar](#the-avatar-endpoint) | `/api/1.0/service/avatar/{user}/{size}` | GET | no | Returns the avatar image for a user |
|
|
|
| [favicon](#the-favicon-endpoint) | `/api/1.0/service/favicon/{domain}/{size}` | GET | no | Returns a favicon image for a domain |
|
|
|
| [preview](#the-preview-endpoint) | `/api/1.0/service/preview/{domain}/{view}/{width}/{height}` | GET | no | Returns a preview image for a domain |
|
|
|
| [hashes](./Service-API/Hashes-API) | `/service/hashes/{range}` | GET & POST | no | Returns breached hashes for the given range |
|
|
|
| [password-change](./Service-API/Password-Change-API) | `/api/1.0/service/password-change` | POST | no | Find the url of the password change page for a domain |
|
|
|
|
|
|
|
|
|
|
... | ... | @@ -137,30 +137,4 @@ This action returns a jpeg image file on success |
|
|
- You can specify a range for width and height by passing `SIZE...`, `SIZE...SIZE` or `...SIZE` where size is a number.
|
|
|
The left value will be the minimum and the right value the maximum.
|
|
|
The api will try to generate an image that fits the given values without cropping
|
|
|
- The resulting image will always have a minimum width and height of 240 pixels
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The password change url endpoint
|
|
|
The password change url endpoint will attempt to determine the url of the "Change password page" for the given domain.
|
|
|
|
|
|
#### URL
|
|
|
| Path | Method | Session required |
|
|
|
|------------------------------------|--------|------------------|
|
|
|
| `/api/1.0/service/password-change` | GET | no |
|
|
|
|
|
|
#### Arguments
|
|
|
| Arguments | Type | Default | Required | Description |
|
|
|
|-----------|--------|---------|----------|-----------------|
|
|
|
| domain | string | - | yes | The domain name |
|
|
|
|
|
|
#### Return value
|
|
|
The success status code is `200 Ok` and `404 Not Found` if no url could be determined.
|
|
|
|
|
|
| Argument | Type | Description |
|
|
|
|----------|--------|----------------------------------------------------|
|
|
|
| url | string | The URL of the password change page for the domain |
|
|
|
|
|
|
#### Notes
|
|
|
- This api requires at least version 2023.3 |
|
|
\ No newline at end of file |
|
|
- The resulting image will always have a minimum width and height of 240 pixels |
|
|
\ No newline at end of file |