DOCSEARCHbyAlgolia
Submit Docs

Appoint Documentation

website·Indexed 29 days ago

https://read-appoint.vercel.app

Technical documentation for the Appoint service, covering merchant account management, legal entity structures, financial reporting, reservation notification mechanisms, and application distribution via App Store and TestFlight. Includes developer tools such as the Debug Screen and guidelines for file upload validation and search list sorting.

Tokens
5.2K
Snippets
18
Records
42
Agent score
74%

What's inside Appoint

  1. Understand the core system tools and applications

    The service consists of three primary applications: the Admin Panel for system management, the Personal Account (Личный кабинет) for business content management, and the Mobile Application for end-users.

  2. Use the Debug Screen for environment and setting management

    The Debug Screen is a specialized application interface designed for developers and testers. It allows users to switch between different environments and modify application settings directly within the app.

  3. Understand the role of a Legal Entity in the merchant system

    A Legal Entity is a mandatory business entity created within a Brand; a Brand cannot be created without a Legal Entity. It serves as the primary entity for financial operations, including registration data, bank details, and the generation of merchant reports. All financial operations and reporting are linked directly to the Legal Entity. One or more Locations can be created within a single Legal Entity.

  4. Server-side media processing and UX guidelines

    The server automatically handles the following for uploaded media:

    • Conversion to AVIF / WebP
    • Aspect ratio validation
    • Auto-cropping
    • Responsive size generation
    • CDN delivery with lazy loading

    UX Recommendations:

    • The first element in a gallery is used as the hero image.
    • Ensure critical content is within the Safe Area.
    • Videos should avoid sharp transitions or flashes.

  5. Implement default search result sorting for events and places

    The application uses a set of default sorting rules for search results (Events and Places) after they have been filtered. The sorting logic is determined by the user's city context and geolocation status.

    City Priority for Context:

    1. Selected City: The city explicitly chosen by the user in the search interface.
    2. Home City: The city specified in the user's profile.

    Sorting Rules:

    • By distance from user: Applied only if geolocation is enabled AND the search is conducted within the user's Home City.
    • From city center: Applied in all other cases (e.g., geolocation is disabled, search is in a different city, or the user is too far from their home city).

    Geolocation Constraints:

    • Geolocation only affects the sorting order; it never changes the city used for filtering.
    • If the user is more than 50 km away from their Home City, geolocation is ignored, and sorting reverts to 'from city center'.

  6. Configure email notifications for Appoint booking cancellations

    The Appoint system sends an email notification to administrators when a user cancels an existing booking.

    • Trigger: Sent immediately after a user successfully cancels a booking.
    • Recipient: order@appoint.ru
    • Date/Time Format: Recommended format is DD.MM.YYYY HH:MM.

    Subject: Отмена бронирования в appoint

    Body: Бронирование услуги/события «service_name» у партнёра «brand_name» на service_start_datetime было отменено пользователем.

    Информация о клиенте

    • ФИО: user_name
    • Телефон: user_phone

    Информация о партнёре

    • Название: brand_name
    • Адрес: partner_address
    • Контактный email: partner_email
    • Контактный телефон: partner_phone

  7. Sequence of report document generation

    Documents must be generated in a specific order because subsequent reports depend on the data from previous ones:

    1. Period Closure: Fix the reporting period and create an immutable set of operations.
    2. DETAIL-REP Generation: This is the 'source of truth'. It filters operations by legal entity, determines final statuses, and calculates price, commission, VAT, and the final payout amount. Operations with invalid statuses are excluded.
    3. CORE-REP Generation: Aggregates data from DETAIL-REP, attaches merchant requisites, and calculates final totals and dates.
    4. FORM-REP Generation: Populates a Word template with merchant requisites, the CORE-REP summary table, and the DETAIL-REP detailed list.
    5. README Generation: Automatically generates a file containing deadlines, data decodings, and contact information.

  8. Requirements for Specialist, Space, and Service Covers

    Specialist, Space, and Service covers share the same specifications:

    • Aspect Ratio: 4:3
    • Quantity: Up to 10 files
    • Images:
      • Formats: JPG, WebP, AVIF
      • Dimensions: Min 960×720, Recommended 1280×960, Max 1920×1440
    • Videos:
      • Formats: MP4, WebM
      • Recommended Resolution: 1280×960
      • Max Duration: 15 sec
      • Max File Size: 15 MB

  9. General image and video upload requirements

    The platform supports modern browsers and Retina/HiDPI screens. Key general constraints include:

    Images:

    • Supported Formats: AVIF (primary/priority), WebP (mandatory), JPG (fallback).
    • Dimensions: Maximum long side is 4096 px. Minimum size must not be smaller than the display size; recommended size is 2× the maximum display size.
    • Processing: EXIF data is automatically removed, and images are auto-cropped from the center. A Safe Area of 80–90% should be maintained.
    • Aspect Ratio: Must be strictly followed.

    Videos:

    • Supported Formats: MP4 (H.264 / H.265) as primary, WebM (VP9 / AV1) as optional.
    • Technical Specs: FPS 24–30, audio must be disabled, looping is allowed.
    • Limits: Maximum duration of 30 seconds and maximum file size of 15 MB.

  10. Generate merchant financial reports

    The report generation process automatically creates a set of legally and financially significant documents for each legal entity within a brand for a closed reporting period.

    Input Data Requirements:

    • Operations and bookings
    • Operation status history
    • Merchant contractual terms
    • Legal entity registration and bank details
    • VAT rates (must be retrieved from system configuration)

    Output Deliverables:

    • CSV files (DETAIL, CORE)
    • Word document (FORM)
    • Text file (README)

  11. Requirements for Brand and Location Covers

    Brand and Location covers share the same specifications:

    • Aspect Ratio: 16:19
    • Quantity: Up to 10 files
    • Images:
      • Formats: JPG, WebP, AVIF
      • Dimensions: Min 960×1140, Recommended 1280×1520, Max 1920×2280
      • Max File Size: 3 MB
    • Videos:
      • Formats: MP4, WebM
      • Recommended Resolution: 1080×1280
      • Max Duration: 30 sec
      • Max File Size: 15 MB

  12. Merchant Report Summary Header Requirements

    The automatically generated report summary must include the following fields to ensure the merchant can verify data during the appeal period:
    Reporting Period: [Start Date] - [End Date]
Formation Date: [Date]
Appeal Period: [Start Date] - [End Date]
Planned Payout: [Date or 'No later than Date']