...

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

...

Headers

Request data validation

Authorize

Request to process the request using a token in the headers.

Validate token

• Check token existance

  • in case error return 404 - token was not found

• Check expiration date tokens.expires_at 

  • if  tokens.expires_at < now() return 401 - access denied

• Extract user_id from token

• Check user scopes in order to perform this action (scope = ''person:read")

  1. Return 403 in case invalid scope(s) - "Your scope does not allow to access this resource. Missing allowances: "person:read"

...

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "type": "sms",
    "factor": "+380881234567",
    "is_active": true,
    "user_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
  }
}

...

Post-processing processes

N/A

Technical modules where the method is used

...

modules where the method is used