Go/Organic WordPress Plugin

A powerful WordPress plugin designed to bulk-create posts via a REST API and manage integration credentials for external SEO content generation services.

Description

The Go/Organic WP Plugin provides a seamless integration between WordPress and external content generation services. It allows you to bulk-create posts through a REST API endpoint and automatically manages authentication credentials for secure API access.

Features

• Bulk Post Creation: Create multiple WordPress posts in a single API call
• Posts Export: Export posts in JSON or CSV format with filtering options
• Automatic Category Management: Create categories on-the-fly or assign posts to existing ones
• Flexible Slug Handling: Support for category-based URL structures (e.g., category/post-slug)
• Secure Authentication: Application Password-based authentication for API access
• Custom Role System: Fine-grained permissions with custom capabilities
• Dynamic API Users: Unique API usernames per installation
• Admin Interface: Easy-to-use admin panel for managing integration credentials
• Automatic Updates: Built-in update checker for seamless plugin updates

Installation

1. Download the plugin files to your WordPress /wp-content/plugins/ directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Navigate to the 'Go/Organic' menu in your WordPress admin panel to configure credentials

API Usage

Bulk Create Posts Endpoint

Endpoint: POST /wp-json/seo-gen/v1/posts

Authentication: Basic Authentication using Application Password

Export Posts Endpoint

Endpoint: GET /wp-json/seo-gen/v1/posts/export

Authentication: Basic Authentication using Application Password

Query Parameters:

• format - Export format: json (default) or csv
• category - Filter by category slug
• status - Filter by post status (default: publish)
• author - Filter by author ID
• date_from - Filter posts from date (Y-m-d)
• date_to - Filter posts to date (Y-m-d)
• per_page - Posts per page (default: 50)
• page - Page number (default: 1)

Headers:

Content-Type: application/json
Authorization: Basic [base64_encoded_credentials]

Request Format

{
  "posts": [
    {
      "id": "external_id_1",
      "title": "Your Post Title",
      "content": "<p>Your post content here...</p>",
      "slug": "category/post-slug",
      "excerpt": "Optional post excerpt",
      "status": "publish",
      "date": "2024-01-01 12:00:00",
      "author": 1,
      "comment_status": "open",
      "ping_status": "open"
    }
  ]
}

Request Parameters

Response Format

{
  "created_posts": [
    {
      "new_id": 123,
      "source_id": "external_id_1",
      "url": "https://yoursite.com/category/post-slug/",
      "title": "Your Post Title",
      "slug": "post-slug",
      "category": "category"
    }
  ],
  "errors": [
    {
      "source_id": "external_id_2",
      "title": "Failed Post",
      "message": "Error description"
    }
  ]
}

Configuration

Setting Up API Credentials

1. Go to WordPress Admin > Go/Organic
2. Click "Generate New Application Password"
3. Copy the generated password immediately (it won't be shown again)
4. Use the provided username and password for API authentication

Authentication Details

• Username: Dynamic per installation (e.g., go_organic_yoursite_com)
• Password: Application Password (generated through admin interface)
• User Role: Editor with custom Go/Organic capabilities
• Permissions:
  • go_organic_manage_posts - Create/import posts
  • go_organic_export_posts - Export posts
  • go_organic_manage_settings - Manage plugin settings (admin only)

Slug Formats

The plugin supports two slug formats:

1. Simple Slug: my-post-title

   • Assigns post to the default category

2. Category/Slug Format: category-name/my-post-title

   • Creates the category if it doesn't exist
   • Assigns the post to the specified category

Error Handling

The API provides detailed error information for failed post creations:

• Missing title or slug
• Invalid slug format
• Category creation failures
• Post insertion errors

Requirements

• WordPress 5.0 or higher
• PHP 7.4 or higher
• Application Passwords enabled
• User with custom Go/Organic capabilities for API access
• User with go_organic_manage_settings capability for admin configuration

Security

• Uses WordPress Application Passwords for secure API authentication
• Custom role system with fine-grained permissions
• Dynamic API usernames unique per installation
• Sanitizes all input data
• Validates user permissions
• Prevents direct file access

Version Information

• Current Version: 0.8.0
• Author: Purple Box AI
• Update Server: Automatic updates via built-in update checker

Support

For support and updates, the plugin automatically checks for new versions from the configured update server. Make sure your WordPress installation can make outbound HTTP requests for automatic updates to work.

License

This plugin includes the Plugin Update Checker library, which has its own licensing terms. Please refer to the plugin-update-checker/license.txt file for details.

Changelog

Version 0.8.0

• NEW: Posts export endpoint with JSON/CSV support
• NEW: Custom role system with fine-grained permissions
• NEW: Dynamic API usernames per installation
• IMPROVED: Better security with custom capabilities
• IMPROVED: Enhanced filtering options for export

Version 0.7.0

• Major code organization and cleanup
• Separated functionality into focused modules
• Enhanced documentation and maintainability

Version 0.3.0

• Initial release with bulk post creation functionality
• Admin interface for credential management
• Automatic category creation
• Flexible slug handling
• Built-in update checker