ЕСОЗ - публічна документація
Private. Generate media storage links
Purpose
This method is designed to generate links to media storage for thirds parties as a part of:
ambulatory contracts process
Specification
Link | Посилання на Apiary або Swagger | |
Resource |
| Посилання на ресурс, наприклад: /api/persons/create |
Scope | private_contracts:write | Scope для доступу |
Components |
| Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices |
| Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type |
| Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type |
| Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async |
| Метод є синхронним чи асинхронним? |
Public/Private/Internal |
| Потрібно зазначити тип методу за ступенем доступності |
Logic
Only authenticated and authorized user can use this service
All files will be stored in separated bucket
Configuration
Create new separated bucket for such files
Bucket name - ambulatory_contracts (prod), ambulatory_contracts-preprod (preprod), ambulatory_contracts-demo (demo)
Request structure
See on Apiary
Authorize
Verify the validity of api-key
Return 401 in case validation fails
Verify the validity of token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'private_contracts:write')
Return 403 in case invalid scope(s)
Headers
Request data validation
Validate request using JSON schema
Return 422 in case validation fails
Processing
Invoke AEL rpc - generate secure link for requested action, resource_id (folder identifier - contractor_legal_entity_id) and resource_name (file name*) in configured bucket
*If the file name consists of several words, it must be encoded using Percent-encoding before executing the request.
Response structure
See on Apiary
Post-processing processes
HTTP status codes
ЕСОЗ - публічна документація