UContacts API

Getting Started

  • Quick Start
  • Configuration
  • Authentication
  • Authorization
  • Deployment

API Reference

  • API Reference
  • Query Syntax
  • Contact API

More

  • About UContacts
UContacts API
  • UContacts REST API Service documentation
  • View page source

UContacts REST API Service documentation

The UContacts REST API Service is a application that provides a REST API for managing contacts. You can add, delete, update and get contacts. UContacts porovide secure API for managing contacts. All contacts are stored in the database, and reqire authentication for managing. User can manage only their contacts.

API Documentation

Demo Sites

  • https://try.api.ucontacts.d0s.site

Contents

Getting Started

  • Quick Start
    • Prerequisites
    • Installation(without Docker)
    • Configuration
    • Running the Application
    • Installation(with Docker)
    • API Documentation
  • Configuration
    • Environment Variables
    • Example .env File
    • Configuration Module
  • Authentication
    • Authentication Flow
    • API Endpoints
    • API Implementation
    • Using Authentication
    • Token Expiration
  • Authorization
    • User Roles
    • Role Assignment
    • Permission Checking
    • Error Responses
    • Future Enhancements
  • Deployment
    • Docker Compose Deployment
    • Deployment Commands
    • Manual Deployment

API Reference

  • API Reference
    • Common Conventions
    • Resource Types
    • Error Responses
    • Pagination
    • Filtering
    • Caching
  • Query Syntax
    • Filter Operators
    • Available Filters
    • Query Examples
    • Response Pagination
    • Error Handling
    • Performance Considerations
  • Contact API
    • Swagger/Redoc UI documentation (Demo)
    • API Endpoints
    • Error Responses
    • Implementation Details
    • Models and Schemas
    • Caching

More

  • About UContacts
    • Overview
    • History
    • Key Features
    • Technology Stack
    • Contributing
    • Future Plans
    • License
    • Contact
Next

© Copyright 2025, Hrebynakha Anatolii.

Built with Sphinx using a theme provided by Read the Docs.