MCP W0TO API

https://mcp-w0to.onrender.com/api/
Admin
This project is an API endpoint hosted on Render.
Tokens:3,963
Snippets:22
Trust Score:6.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get All Partners - GET /admin/partners

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves a paginated list of all partners, supporting filtering by CNPJ, name, active status, and sorting options. Returns comprehensive partner data.

```json
{
  "path": "/admin/partners",
  "method": "GET",
  "summary": "Get all partners",
  "description": "Retrieves a paginated list of all partners in the system. Supports filtering by various criteria such as CNPJ, name, active status, and sorting options. Returns partner information including company details, contact data, and commission rates.",
  "operationId": "PartnersController_getAllPartners",
  "tags": [
    "Partners"
  ],
  "parameters": 20,
  "hasRequestBody": false,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "500"
  ]
}
```

--------------------------------

### Get One Partner - GET /admin/partners/{partnerId}

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves detailed information for a specific partner using their unique identifier. Includes complete partner data such as company details, contact information, address, and commission configuration.

```json
{
  "path": "/admin/partners/{partnerId}",
  "method": "GET",
  "summary": "Get one partner",
  "description": "Retrieves detailed information for a specific partner by their unique identifier. Returns complete partner data including company details, contact information, address, and commission configuration.",
  "operationId": "PartnersController_getOnePartner",
  "tags": [
    "Partners"
  ],
  "parameters": 1,
  "hasRequestBody": false,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Get All Stores - Stores API

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves a paginated list of all stores for a specific company. Administrators can use this endpoint to view store information, including names, status, and creation dates. It supports pagination for efficient browsing and requires authentication and company-level authorization.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/stores",
  "method": "GET",
  "summary": "Get all stores",
  "description": "Retrieves a comprehensive paginated list of all stores belonging to a specific company. This endpoint provides administrators with an overview of all store locations including essential information such as store names, operational status, creation dates, and other relevant metadata. The response includes pagination controls with configurable page size and navigation, making it efficient to browse through large numbers of stores. Requires proper authentication and company-level authorization to ensure data security and access control.",
  "operationId": "StoresController_getAllStores",
  "tags": [
    "Stores"
  ],
  "parameters": 1,
  "hasRequestBody": false,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Get All Companies API

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves a list of all companies. This endpoint supports multiple query parameters for filtering and sorting.

```HTTP
GET /admin/companies
```

--------------------------------

### Get One Store - Stores API

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves detailed information for a specific store within a company, identified by both company and store IDs. This endpoint allows administrators to view comprehensive store data, including status and timestamps. Proper authentication and authorization are required.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/stores/{storeId}",
  "method": "GET",
  "summary": "Get one store",
  "description": "Retrieves detailed information of a specific store within a company. This endpoint allows administrators to access comprehensive store data including store identification, name, operational status, creation and modification timestamps, and other relevant store-specific information. The store is identified by both company ID and store ID parameters to ensure proper data isolation and security. Requires proper authentication and authorization to access store information.",
  "operationId": "StoresController_getOneStore",
  "tags": [
    "Stores"
  ],
  "parameters": 2,
  "hasRequestBody": false,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Get All Company Users - Company Users API

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves a paginated list of all users associated with a specific company. This endpoint returns user details such as ID, name, email, status, and timestamps, along with pagination metadata. Authentication and company-level authorization are required.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/users",
  "method": "GET",
  "summary": "Get all company users",
  "description": "Endpoint to retrieve a paginated list of all users associated with a specific company. Returns user information including ID, name, email, active status, and creation/update timestamps, along with pagination metadata such as current page, limit, total count, and total pages.",
  "operationId": "CompanyUsersController_getAll",
  "tags": [
    "Company Users"
  ],
  "parameters": 7,
  "hasRequestBody": false,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Get Company by ID API

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves a specific company by its unique identifier.

```HTTP
GET /admin/companies/{companyId}
```

--------------------------------

### Get One Company User - Company Users API

Source: https://mcp-w0to.onrender.com/api/endpoints

Retrieves detailed information for a specific company user by their unique identifier. This endpoint allows administrators to view comprehensive user data, including personal information, role, and status. It requires the user's ID and company ID for data isolation.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/users/{userId}",
  "method": "GET",
  "summary": "Get one company user",
  "description": "Endpoint to retrieve detailed information about a specific company user by their unique identifier. Returns comprehensive user data including personal information, role, status, and associated company details. This endpoint is used for viewing individual user profiles and managing user-specific operations within the company context.",
  "operationId": "CompanyUsersController_getOne",
  "tags": [
    "Company Users"
  ],
  "parameters": 2,
  "hasRequestBody": false
}
```

--------------------------------

### Create Partner - POST /admin/partners

Source: https://mcp-w0to.onrender.com/api/endpoints

Creates a new partner with all required information, including company details, contact information, address data, and commission rates. All fields in the request body are mandatory.

```json
{
  "path": "/admin/partners",
  "method": "POST",
  "summary": "Create a new partner",
  "description": "Creates a new partner in the system with all required information including company details, contact information, address data, and commission rates. All fields in the request body are required for partner creation.",
  "operationId": "PartnersController_createPartner",
  "tags": [
    "Partners"
  ],
  "parameters": 0,
  "hasRequestBody": true,
  "responses": [
    "201",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Administrator Sign In API

Source: https://mcp-w0to.onrender.com/api/endpoints

Handles secure authentication for system administrators to access the Directa Shop administrative platform. It validates credentials, performs email verification, generates JWT tokens with Redis session management, and establishes role-based access control.

```HTTP
POST /admin/users/sign-in
```

--------------------------------

### Administrator Registration API

Source: https://mcp-w0to.onrender.com/api/endpoints

Provides secure registration for new system administrator accounts. It validates credentials, enforces password policies, assigns roles, and initiates email verification with token generation.

```HTTP
POST /admin/users
```

--------------------------------

### Create Company API

Source: https://mcp-w0to.onrender.com/api/endpoints

Adds a new company to the system. Supports adding search filters using column=operator(value) syntax, with valid operators including eq, ne, gt, gte, lt, lte, cont, between.

```HTTP
POST /admin/companies
```

--------------------------------

### Create Store - Stores API

Source: https://mcp-w0to.onrender.com/api/endpoints

Creates a new store for a specified company. This endpoint requires administrator privileges and accepts store details in the request body. It returns a success status code upon creation or error codes for invalid requests or authorization failures.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/stores",
  "method": "POST",
  "summary": "Create a store",
  "description": "Creates a new store for the specified company. This endpoint allows administrators to register a new store location with complete information including store name, address, contact details, operating hours, and other relevant business information. The store will be associated with the company specified in the request parameters and requires proper authentication and authorization to ensure only authorized personnel can create new store locations.",
  "operationId": "StoresController_createStore",
  "tags": [
    "Stores"
  ],
  "parameters": 1,
  "hasRequestBody": true,
  "responses": [
    "201",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Create Company User - Company Users API

Source: https://mcp-w0to.onrender.com/api/endpoints

Creates a new user for a specific company. Administrators can add users by providing their profile information, including name, email, and role. The endpoint returns a success status code upon creation or error codes for invalid input or authorization issues.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/users",
  "method": "POST",
  "summary": "Create company user",
  "description": "Endpoint to create a new company user. Allows administrators to add new users to a specific company with their profile information including name, email, role, and other necessary details for system access and permissions.",
  "operationId": "CompanyUsersController_create",
  "tags": [
    "Company Users"
  ],
  "parameters": 1,
  "hasRequestBody": true,
  "responses": [
    "201",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Administrator Email Verification API

Source: https://mcp-w0to.onrender.com/api/endpoints

Validates and activates administrator accounts using secure verification tokens. This endpoint confirms email authenticity, activates accounts, and updates account status with audit logging.

```HTTP
POST /admin/users/email-verify
```

--------------------------------

### Update Partner - PATCH /admin/partners/{partnerId}

Source: https://mcp-w0to.onrender.com/api/endpoints

Updates an existing partner's information with partial updates. Only the fields provided in the request body are modified. All fields, including company details, contact information, address data, and commission rates, are optional.

```json
{
  "path": "/admin/partners/{partnerId}",
  "method": "PATCH",
  "summary": "Update a partner",
  "description": "Updates an existing partner's information. Allows partial updates - only the fields provided in the request body will be modified. All fields are optional, including company details, contact information, address data, and commission rates.",
  "operationId": "PartnersController_updatePartner",
  "tags": [
    "Partners"
  ],
  "parameters": 1,
  "hasRequestBody": true,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Resend Administrator Verification Email API

Source: https://mcp-w0to.onrender.com/api/endpoints

Resends email verification messages to administrator accounts requiring activation. It generates new tokens, sends verification emails, and manages rate limiting.

```HTTP
POST /admin/users/send-verification-email
```

--------------------------------

### Administrator Sign Out API

Source: https://mcp-w0to.onrender.com/api/endpoints

Terminates administrator sessions and invalidates authentication tokens. It blacklists JWT tokens in Redis, clears session data, and logs logout activity.

```HTTP
POST /admin/users/sign-out
```

--------------------------------

### Update Store - Stores API

Source: https://mcp-w0to.onrender.com/api/endpoints

Updates an existing store's details, such as name, address, or contact information. This endpoint requires administrator privileges and the store's ID. It accepts updated information in the request body and returns a success status code or error codes for invalid operations.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/stores/{storeId}",
  "method": "PATCH",
  "summary": "Update a store",
  "description": "Updates an existing store with new information. This endpoint allows administrators to modify store details such as name, address, contact information, operating hours, and other store-specific settings. The operation requires proper authentication and authorization to ensure only authorized personnel can make changes to store data.",
  "operationId": "StoresController_updateStore",
  "tags": [
    "Stores"
  ],
  "parameters": 2,
  "hasRequestBody": true,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Update Company API

Source: https://mcp-w0to.onrender.com/api/endpoints

Updates the details of a specific company identified by its ID.

```HTTP
PATCH /admin/companies/{companyId}
```

--------------------------------

### Update Company User - Company Users API

Source: https://mcp-w0to.onrender.com/api/endpoints

Updates the information of an existing company user. Administrators can modify user details like name, email, and role for users within a specific company. The endpoint requires the user's ID and accepts updated information in the request body.

```OpenAPI
{
  "path": "/admin/companies/{companyId}/users/{userId}",
  "method": "PATCH",
  "summary": "Update company user",
  "description": "Endpoint to update an existing company user's information. Allows administrators to modify user details such as name, email, role, and other profile information for users within a specific company.",
  "operationId": "CompanyUsersController_update",
  "tags": [
    "Company Users"
  ],
  "parameters": 2,
  "hasRequestBody": true,
  "responses": [
    "200",
    "400",
    "401",
    "403",
    "404",
    "500"
  ]
}
```

--------------------------------

### Update Company Status API

Source: https://mcp-w0to.onrender.com/api/endpoints

Updates the active status of a company.

```HTTP
PATCH /admin/companies/{companyId}/active
```
Tokens:
Raw