Generic documentation

Introduction

What is?

Helper is an application that is used for helping people find any services around them in a very quick time.

<aside> 📱 Usage:

</aside>

How it works?

Project structure

<aside> <img src="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/0d31710f-bada-4d1d-b505-aaf6043da188/web-size_1073465.png" alt="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/0d31710f-bada-4d1d-b505-aaf6043da188/web-size_1073465.png" width="40px" /> Backend Server side structure made of by using SpringBoot KT

</aside>

<aside> <img src="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/8ace4e49-9641-431a-9cf1-6d7680f2da66/webpage_14380808.png" alt="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/8ace4e49-9641-431a-9cf1-6d7680f2da66/webpage_14380808.png" width="40px" /> Frontend Front-end mobile made of by using Kotlin Multiplatform (ComposeUI framework)

</aside>

<aside> <img src="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/afbc9989-d0f7-4418-9c04-dd52590dff40/interface_14549281.png" alt="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/afbc9989-d0f7-4418-9c04-dd52590dff40/interface_14549281.png" width="40px" /> Database User Data - Posts Data on PostgresSQL Secondary features on MongoDB

</aside>

<aside> <img src="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/4bff24a9-4f8d-4b3a-ac30-7b6b9d9d8ade/devops.png" alt="https://prod-files-secure.s3.us-west-2.amazonaws.com/97b6bdcb-5e88-4b2d-bc5b-aba94d4f08be/4bff24a9-4f8d-4b3a-ac30-7b6b9d9d8ade/devops.png" width="40px" /> DevOps integration CI/CD Ratchet Strategy

</aside>

System design

Conventions

The base URL to send all API requests is https://api.devmate.app HTTPS is required for all API requests.

The Devmate API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests on page and database resources. Request and response bodies are encoded as JSON.

JSON CONVENTIONS

• Top-level resources have an "object" property. This property can be used to determine the type of the resource (e.g. "database", "user", etc.)
• Top-level resources are addressable by a UUIDv4 "id" property. You may omit dashes from the ID when making requests to the API, e.g. when copying the ID from a Devmate url.
• Property names are in snake_case (not camelCase or kebab-case).
• Temporal values (dates and datetimes) are encoded in ISO 8601 strings. Datetimes will include the time value (2020-08-12T02:12:33.231Z) while dates will include only the date (2020-08-12)

Pagination

Endpoints that return lists of objects support cursor-based pagination requests. By default, Devmate returns ten items per API call. If the number of items in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned items.

SUPPORTED ENDPOINTS

RESPONSES

Status Codes

HTTP response codes are used to indicate general classes of success and error.

Success Code

Error Codes

Error responses contain more detail about the error in the response body, in the "code" and "message"properties.

Versioning

Our API versions are named for the date the version is released.

You set the version by including a Devmate-Version header. Setting the Devmate-Version header in required.

curl <https://api.devmate.app/v1/users/01da9b00-e400-4959-91ce-af55307647e5> \\
  -H "Authorization: Bearer secret_t1CdN9S8yicG5eWLUOfhcWaOscVnFXns"
  -H "Notion-Version: 2025-05-15"

Objects

Users

Where user objects appear in the API

User objects appear in the API in nearly all objects returned by the API, including:

• Block object under created_by and last_edited_by.
• Page object under created_by and last_edited_by and in people property items.
• Database object under created_by and last_edited_by.
• Rich text object, as user mentions.
• Property object when the property is a people property.

User objects will always contain object and id keys, as described below. The remaining properties may appear if the user is being rendered in a rich text or page property context, and the bot has the correct capabilities to access those properties. For more about capabilities, see the Capabilities guide and the Authorization guide.

All users

These fields are shared by all users, including people and bots. Fields marked with * are always present.

File

File objects contain data about a file that is uploaded to Notion, or data about an external file that is linked to in Notion.

{
  "type": "file",
  "file": {
    "url": "<https://s3.us-west-2.amazonaws.com/secure.notion-static.com/7b8b0713-dbd4-4962-b38b-955b6c49a573/My_test_image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45EIPT3X45%2F20221024%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20221024T205211Z&X-Amz-Expires=3600&X-Amz-Signature=208aa971577ff05e75e68354e8a9488697288ff3fb3879c2d599433a7625bf90&X-Amz-SignedHeaders=host&x-id=GetObject>",
    "expiry_time": "2022-10-24T22:49:22.765Z"
  }
}

Page, embed, image, video, file, pdf, and bookmark block types all contain file objects. Icon and cover page object values also contain file objects.

Each file object includes the following fields:

| --- | --- | --- | --- |

Endpoints

Endpoints (1)

Contact us

Email

[email protected] - professional email

Github

https://github.com/Giacomop19 - projects

Linkedin

https://www.linkedin.com/in/giacomo-pumapillo/ - resume