🏠 Home

<aside> <img src="/icons/directional-sign_red.svg" alt="/icons/directional-sign_red.svg" width="40px" /> ROUTES

• Auth Routes
• Log Routes
• Refresh Token Routes
• Payment Routes
• Edit User Routes
• Pet Routes
• Pet Owner Operations Routes
• Animal Keyword Routes
• Care Give Routes
• Chat Routes
• Notification Routes
• Admin Routes

</aside>

Sections Database (Do Not Delete)

<aside> 🗂️ This documentation is strictly for Benek employees. Unauthorized access, sharing, or use of this document is prohibited. All information contained herein is confidential and should not be disclosed outside the company.

</aside>

📝 Benek Server API

About 📖

Benek is an innovative platform connecting pet owners with reliable sitters. Users can easily find nearby sitters, choose care packages, and schedule daily tasks. Benek ensures a secure and organized experience for both users and sitters throughout the process.

Key Features 🌟

• Pet Care Packages: Weekly, daily, or custom plans for medium-sized pets.
• Task Verification: Video recordings with time-stamped codes for sitter accountability.
• Fixed Pricing: Non-negotiable pricing for all packages to ensure transparency.
• Secure Payments: Payments processed via Mokapos with card GUID storage for safety.

Purpose of the API 🌐

The Benek API allows developers to integrate Benek’s functionalities into their own applications or services. With this API, you can:

• Search for nearby pet sitters.
• Manage care packages and scheduling.
• Authenticate users securely.
• Access sitter performance and verification data.

How to Use This Documentation 🛠️

This documentation is designed to help you get started with the Benek API quickly and effectively. Each section includes:

• Endpoints: URL paths and HTTP methods.
• Request Parameters: Required and optional parameters with examples.
• Response Examples: Sample outputs in JSON format.
• Error Codes: Descriptions of potential errors and troubleshooting tips.

🚧  This documentation is a work in progress. Updates will be made regularly.

⚠️  Assistance from ChatGPT was used during the creation of this API documentation to anticipate possible outputs based on given inputs, correct English writing errors, and ensure accurate Markdown formatting.