Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] REST API Initialize OTP Verification [API-010-001-001-0352]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-010-001-001-0352
Microservices (namespace)	MPI
Component	Master Patient Index
Component ID	COM-010-001
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/otp-verification/initialize-otp-verification
Resource	{{host}}/api/verifications
Scope	otp:write
Protocol type	REST
Request type	POST
Sync/Async	Sync
Public/Private	Public

Purpose

This method is designed to verify that provided in the declaration request phone number is valid and is in service. Initialization phase

Logic

The user enters the phone number into the system.

As a result, an SMS is sent to the entered number with OTP code and the system returns the following response to the request:

id = хххх status = NEW code_expired_at = строк придатності коду аctive= true

id = хххх status = NEW code_expired_at = строк придатності коду аctive= true

Generate verification code

Generate verification code using basic random (default) function or time-based algorithm
- Verification code format - digits only ^[1-9][0-9]*$
- Verification code length - configuration parameter (default = 4)
- Verification code expiration period - configuration parameter (default = 15 min)
- Set expiration period using configuration parameter

Deactivate active verification code

Search active verification code(s) for this phone number
- If found - change status to INACTIVE

Save verification code

Save generated verification code to DB

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	phone_number		String	Required	+380508887700
2

Request structure

See on API-specification

{
  "phone_number": "+380508887700"
}

Headers

	Key	Value	Mandatory	Description	Example

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json		Тип контенту	Content-Type:application/json
2	Authorization	Bearer {token}		Перевірка користувача	Authorization:Bearer {token}
3	api-key	{secret}		Секретний ключ	api-key: {secret}

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
    "status": "NEW",
    "code_expired_at": "2017-07-10T12:20:16.300597Z",
    "active": true
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
3
4	Специфічні
5

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

[DRAFT] REST API Initialize OTP Verification [API-010-001-001-0352]