PHPackages                             btafoya/mixpost-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. btafoya/mixpost-api

ActiveLibrary[HTTP & Networking](/categories/http)

btafoya/mixpost-api
===================

REST API add-on for Mixpost - enables n8n and external integrations

v1.0.0(6mo ago)111MITPHPPHP ^8.2CI passing

Since Oct 24Pushed 6mo agoCompare

[ Source](https://github.com/btafoya/mixpost-api)[ Packagist](https://packagist.org/packages/btafoya/mixpost-api)[ Docs](https://github.com/btafoya/mixpost-api)[ RSS](/packages/btafoya-mixpost-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (8)Versions (2)Used By (0)

Mixpost REST API Add-on
=======================

[](#mixpost-rest-api-add-on)

 [![Mixpost Logo](https://raw.githubusercontent.com/inovector/mixpost/main/art/logo.svg)](https://raw.githubusercontent.com/inovector/mixpost/main/art/logo.svg)

 **REST API extension for Mixpost - Enable powerful automation with n8n and external integrations**

 [![Latest Version on Packagist](https://camo.githubusercontent.com/b7cb30e8fc1d5e0cebd744b547f1b008d40f96b39ad3a2f4b7c85f78f6d1335b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f627461666f79612f6d6978706f73742d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/btafoya/mixpost-api) [![GitHub Tests Action Status](https://camo.githubusercontent.com/b34735028c6b033bcdd00e0188b13686f39725e1f9240ffa27d4411ee898adff/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f627461666f79612f6d6978706f73742d6170692f74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/btafoya/mixpost-api/actions) [![Total Downloads](https://camo.githubusercontent.com/5fddf0c7adf58e8cd5a6239922bdd4234bdd9f0eab9c0b31d327101d6fc19533/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f627461666f79612f6d6978706f73742d6170692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/btafoya/mixpost-api) [![License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://github.com/btafoya/mixpost-api/blob/main/LICENSE.md)

---

📖 About
-------

[](#-about)

**Mixpost REST API** is a powerful Laravel package that extends [Mixpost](https://github.com/inovector/mixpost) with comprehensive REST API capabilities. Built specifically to enable seamless integration with workflow automation tools like [n8n](https://n8n.io), this add-on transforms Mixpost into a fully API-driven social media management platform.

### 🎯 Perfect For

[](#-perfect-for)

- **Workflow Automation**: Integrate with n8n, Zapier, Make.com
- **Custom Applications**: Build your own social media management tools
- **AI-Powered Content**: Auto-generate and publish content with AI services
- **Content Pipelines**: Automate blog-to-social workflows
- **Team Collaboration**: External tools can interact with Mixpost programmatically
- **Scheduled Automation**: Time-based social media campaigns

---

✨ Features
----------

[](#-features)

### 🚀 API Coverage (v1.0.0)

[](#-api-coverage-v100)

- ✅ **Posts Management**: Full CRUD operations, scheduling, and publishing
- ✅ **Media Handling**: Upload files, download from URLs, manage library
- ✅ **Account Management**: List and manage social media accounts
- ✅ **Tags & Organization**: Create, update, delete tags

### 🔮 Planned Features (Future Releases)

[](#-planned-features-future-releases)

- 📅 **Analytics & Reports**: Dashboard metrics, account stats, post performance
- 📅 **Calendar Integration**: View and manage scheduled content
- 📅 **System Monitoring**: Check status, queue health, service configuration

### 🔐 Security & Performance

[](#-security--performance)

- ✅ **Laravel Sanctum Authentication**: Secure token-based API access
- ✅ **Rate Limiting**: Configurable request throttling (default: 60/min)
- ✅ **Permission System**: Token abilities for granular access control
- ✅ **HTTPS Enforcement**: Production-ready security
- ✅ **IP Whitelisting**: Optional IP restriction
- ✅ **Input Validation**: Comprehensive server-side validation

### 🎨 Developer Experience

[](#-developer-experience)

- ✅ **RESTful Design**: Clean, predictable API structure
- ✅ **JSON Responses**: Consistent response formats
- ✅ **Pagination**: Efficient data handling for large datasets
- ✅ **Error Handling**: Detailed, actionable error messages
- ✅ **Comprehensive Documentation**: Full API specification and examples
- ✅ **n8n Ready**: Pre-built workflow examples included

---

📋 Requirements
--------------

[](#-requirements)

- **PHP**: ^8.2
- **Laravel**: ^10.47 | ^11.0
- **Mixpost**: ^1.0 (installed automatically as dev dependency)
- **Laravel Sanctum**: ^3.0 | ^4.0

---

🚀 Installation
--------------

[](#-installation)

### Step 1: Install via Composer

[](#step-1-install-via-composer)

```
composer require inovector/mixpost-api
```

### Step 2: Publish Configuration (Optional)

[](#step-2-publish-configuration-optional)

```
php artisan vendor:publish --tag=mixpost-api-config
```

This creates `config/mixpost-api.php` where you can customize:

- API prefix
- Rate limiting
- Token expiration
- Security settings
- Pagination defaults

### Step 3: Run Migrations

[](#step-3-run-migrations)

```
php artisan migrate
```

This creates the `personal_access_tokens` table for Laravel Sanctum.

### Step 4: Update User Model

[](#step-4-update-user-model)

Add the `HasApiTokens` trait to your User model:

```