ЕСОЗ - публічна документація
Update client connection
Purpose
Only redirect uri can be updated using this method
Specification
Link | Посилання на Apiary або Swagger | |
Resource | /api/clients/{{id}}/connections/{{connection_id}} | Посилання на ресурс, наприклад: /api/persons/create |
Scope | connection:write | Scope для доступу |
Components | Manage client configuration | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | PATCH | Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async | Sync | Метод є синхронним чи асинхронним? |
Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
Logic
Extract client_type from token
Validate specified Client ID according to context:
MSP, MIS, PHARMACY - receives only its own client
in case of error generate 403 response ('forbidden')
Update mithril.connections for specified Connection ID and replace redirect_uri with the value from request
Hide secret from response
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id |
| String | Required | 1380df72-275a-11e7-93ae-92361f002671 |
connection_id |
| String | Required | e5372365-d47a-467f-81d0-f35117864352 |
Request structure
Authorize
Verify the validity of access token
in case of error return 401 ('Access denied')
Check user scope connection:write in order to perform this action
in case of error generate 403 response ('Invalid scopes')
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
API-key:uXhEczJ56adsfh3Ri9SUkc4en
Request data validation
Request validation
Validate according JSON Schema
Return 422 with list of validation errors in case validation fails
Processing
API paragraph not found
Response structure
Example:
Post-processing processes
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 | Access denied |
|
403 |
|
|
422 |
| Validation failed |
ЕСОЗ - публічна документація