Pages API - Venddor API

Pages Endpoints

The Pages API allows you to manage content pages in the Venddor platform. This documentation outlines the available endpoints and their supported HTTP methods.

Base URL: https://www.venddor.com.br/api/2.0

Available Endpoints

GET POST /pages/

This endpoint allows you to retrieve all content pages or create a new page.

Supported Methods

Method	Description	Usage
GET	Retrieve all pages	Use pagination parameters to limit results. See Pagination section for details.
POST	Create a new page	Requires a JSON body with page details.

Create Example

List Response

{
  "page": "About Us",
  "page_type": "T",
  "description": "<h1>About Venddor</h1><p>Founded in 2020, Venddor is a leading e-commerce solution provider in Latin America with a focus on innovative retail technologies.</p><p>Our mission is to empower businesses of all sizes to succeed in the digital marketplace through cutting-edge tools and exceptional support.</p>",
  "meta_description": "Learn about Venddor's history, mission, and team",
  "meta_keywords": "about, company, ecommerce, history, venddor",
  "position": 10,
  "status": "A",
  "company_id": 1,
  "parent_id": 0
}

{
  "pages": [
    {
      "page_id": 12,
      "page": "About Us",
      "page_type": "T",
      "position": 10,
      "status": "A",
      "parent_id": 0,
      "timestamp": "2025-04-15T10:15:30Z"
    },
    {
      "page_id": 13,
      "page": "Privacy Policy",
      "page_type": "T",
      "position": 20,
      "status": "A",
      "parent_id": 0,
      "timestamp": "2025-04-15T10:16:45Z"
    },
    {
      "page_id": 14,
      "page": "Terms of Service",
      "page_type": "T",
      "position": 30,
      "status": "A",
      "parent_id": 0,
      "timestamp": "2025-04-15T10:18:12Z"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 3
  }
}

GET PUT DELETE /pages/:id

This endpoint allows you to work with a specific page identified by its ID.

Path Parameters

Parameter	Type	Description
id*	integer	The unique identifier of the page

Supported Methods

Method	Description	Usage
GET	Retrieve a specific page	Returns detailed information about the specified page
PUT	Update a page	Requires a JSON body with fields to update
DELETE	Delete a page	Permanently removes the page from the system

Detail Response

Update Example

{
  "page_id": 12,
  "page": "About Us",
  "page_type": "T",
  "description": "<h1>About Venddor</h1><p>Founded in 2020, Venddor is a leading e-commerce solution provider in Latin America with a focus on innovative retail technologies.</p><p>Our mission is to empower businesses of all sizes to succeed in the digital marketplace through cutting-edge tools and exceptional support.</p>",
  "meta_description": "Learn about Venddor's history, mission, and team",
  "meta_keywords": "about, company, ecommerce, history, venddor",
  "position": 10,
  "status": "A",
  "company_id": 1,
  "parent_id": 0,
  "timestamp": "2025-04-15T10:15:30Z",
  "page_url": "https://www.venddor.com.br/about-us"
}

{
  "description": "<h1>About Venddor</h1><p>Founded in 2020, Venddor is a leading e-commerce solution provider in Latin America with a focus on innovative retail technologies.</p><p>Our mission is to empower businesses of all sizes to succeed in the digital marketplace through cutting-edge tools and exceptional support.</p><h2>Our Team</h2><p>Our team consists of industry experts with decades of combined experience in retail, technology, and customer service.</p>",
  "meta_description": "Learn about Venddor's history, mission, and expert team members"
}

Tip: When updating page content, you can use HTML markup in the description field to format your content. The platform supports standard HTML tags including headings, paragraphs, lists, tables, and images.

Page Types

Type Code	Description
`T`	Text page - Standard content page with formatted text
`F`	Form page - Page containing a form for user input
`L`	Link page - Page that redirects to an external URL
`B`	Blog page - Page formatted for blog content display

Page Status Values

Status	Description
`A`	Active - Page is visible to users
`H`	Hidden - Page exists but is not visible in navigation
`D`	Disabled - Page is temporarily disabled
`P`	Password-protected - Page requires a password to access

SEO Optimization

The Pages API allows you to optimize your content for search engines by setting the following fields:

Field	Description
`meta_description`	A concise description of the page content (recommended 150-160 characters)
`meta_keywords`	Comma-separated list of keywords relevant to the page content
`page_title`	Custom title tag for the page, if different from the page name
`seo_name`	URL-friendly version of the page name for SEO-friendly URLs

Note: When creating or updating pages with HTML content, all HTML tags must be properly escaped in the JSON payload. The platform will automatically validate and sanitize HTML to prevent security issues.