| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
This method is designed to verify that provided in the declaration request phone number is valid and is in service. Final stage
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
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 | |
|---|---|---|---|---|---|
| 1 | phone_number |
| String | Required | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 |
Attributes
Attribute | Values | Type | Description | Example |
|---|---|---|---|---|
code |
| Number |
| 3782 |
Request structure
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
...
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
To confirm the verification, you must enter the phone number and OTP (one-time code) in the system
...
Response structure examples
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
...
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
| Page Properties Report | ||||
|---|---|---|---|---|
|
...