MagicUI API Documentation

MagicUI API provides RESTful API services for your WordPress and WooCommerce-based e-commerce application. It offers secure access through JWT (JSON Web Token) based authentication system.

Base URL

https://your-domain.com/wp-json/

Authentication

The API uses JWT (JSON Web Token) based authentication. Most endpoints require a valid JWT token.

How to Get a Token?

Use the /jwt-auth/v1/token endpoint to obtain a token. After receiving the token, you need to send it in the Authorization header for every request to protected endpoints.

Authorization: Bearer YOUR_JWT_TOKEN

🔐 Authentication Endpoints

User login to obtain JWT token.

Endpoint: POST /jwt-auth/v1/token

Authentication: Not required

Request Body:

{
  "username": "[email protected]",
  "password": "your_password"
}

Success Response (200):

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
  "user": {
    "id": 1,
    "username": "john_doe",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "roles": ["customer"],
    "woocommerce": {
      "customer_id": 1,
      "billing": {
        "account_type": "individual",
        "identity_number": "12345678901",
        "tax_id_number": "",
        "company_name": "",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "+905551234567",
        "address_1": "Sample Address",
        "address_2": "",
        "city": "Istanbul",
        "state": "TR34",
        "postcode": "34000",
        "country": "TR"
      },
      "shipping": {
        "first_name": "John",
        "last_name": "Doe",
        "address_name": "Home",
        "address_1": "Sample Address",
        "address_2": "",
        "city": "Istanbul",
        "state": "TR34",
        "postcode": "34000",
        "country": "TR",
        "phone": "+905551234567"
      }
    }
  },
  "token_type": "Bearer",
  "expires_in": 604800
}

Error Response (401):

{
  "code": "invalid_credentials",
  "message": "Invalid email or password.",
  "data": {
    "status": 401
  }
}

Notes:

Token validity is 7 days (604800 seconds)
Login uses email address
Token is used for all protected endpoints

2. Token Validation

Validates the current token.

Endpoint: POST /jwt-auth/v1/token/validate

Authentication: Bearer Token

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Success Response (200):

{
  "code": "jwt_auth_valid_token",
  "data": {
    "status": 200,
    "user": 1
  }
}

Error Response (401):

{
  "code": "expired_token",
  "message": "Token has expired.",
  "data": {
    "status": 401
  }
}

3. Token Refresh

Refreshes the current token to get a new one.

Endpoint: POST /jwt-auth/v1/token/refresh

Authentication: Bearer Token

Headers:

Authorization: Bearer YOUR_JWT_TOKEN

Success Response (200):

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
  "token_type": "Bearer",
  "expires_in": 604800
}

👤 User Registration

Register New User

Creates a new user account and automatically logs in.

Endpoint: POST /magicui/v1/register

Authentication: Copy the API Key from the MagicUI Plugin API Endpoint and use it to send a POST request to the register endpoint.

Request Body:

{
  "email": "[email protected]",
  "username": "newuser",
  "password": "SecurePassword123",
  "first_name": "John",
  "last_name": "Doe",
  "magicui_api_key": "nn0zj9BcI0qep2YqqGfp2PNgBx4be7fy"
}

Success Response (200):

{
  "success": true,
  "message": "User registered successfully.",
  "token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
  "user": {
    "id": 5,
    "username": "newuser",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "roles": ["customer"],
    "woocommerce": {
      "customer_id": 5,
      "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]"
      }
    }
  },
  "token_type": "Bearer",
  "expires_in": 604800
}

Error Response (400):

{
  "code": "email_exists",
  "message": "Email already registered.",
  "data": {
    "status": 400
  }
}

Validation Rules:

Email must be in valid email format
Username must be unique
Password must be at least 6 characters
Email must be unique

🛍️ Product Endpoints

1. Product List

Lists WooCommerce products. Supports filtering, searching, and pagination.

Endpoint: GET /magicui/v1/products

Authentication: Not required

Query Parameters:

Parameter

Type

Description

Default

page

integer

Page number

per_page

integer

Products per page

search

string

Search in product name

category

integer

Filter by category ID

orderby

string

Sort criteria (date, title, price, popularity, rating)

date

order

string

Sort direction (ASC, DESC)

DESC

on_sale

boolean

Sale products only

false

featured

boolean

2. Product Details

Retrieves detailed information about a specific product.

Endpoint: GET /magicui/v1/products/{id}

Authentication: Not required

Path Parameters:

Parameter

Type

Description

id

integer

Product ID

Success Response (200):

{
  "id": 123,
  "name": "Sample Product",
  "description": "Detailed product description...",
  "price": 299.99,
  "images": [
    {
      "id": 456,
      "src": "https://example.com/image.jpg",
      "name": "Product Image",
      "alt": "Alt Text"
    }
  ],
  "stock_status": "instock",
  "stock_quantity": 50,
  "attributes": [],
  "variations": [],
  "grouped_products": []
}

3. Product Variations

Lists variations of variable products.

Endpoint: GET /magicui/v1/products/{id}/variations

Authentication: Not required

Success Response (200):

[
  {
    "id": 124,
    "sku": "PROD-123-RED-L",
    "price": 299.99,
    "regular_price": 399.99,
    "sale_price": 299.99,
    "on_sale": true,
    "stock_status": "instock",
    "stock_quantity": 10,
    "manage_stock": true,
    "purchasable": true,
    "attributes": [
      {
        "id": 0,
        "name": "Color",
        "option": "Red"
      },
      {
        "id": 0,
        "name": "Size",
        "option": "L"
      }
    ]
  }
]

4. Categories

Lists product categories.

Endpoint: GET /magicui/v1/categories

Authentication: Not required

Query Parameters:

Parameter

Type

Description

Default

page

integer

Page number

per_page

integer

Categories per page

100

parent

integer

Parent category ID

hide_empty

boolean

Hide empty categories

true

orderby

string

Sort criteria

name

order

string

Sort direction

ASC

Success Response (200):

[
  {
    "id": 15,
    "name": "Electronics",
    "slug": "electronics",
    "parent": 0,
    "description": "Electronic products",
    "display": "default",
    "image": {
      "id": 789,
      "src": "https://example.com/category-image.jpg"
    },
    "menu_order": 0,
    "count": 45
  }
]

5. Product Reviews

Lists reviews for a product.

Endpoint: GET /magicui/v1/products/{id}/reviews

Authentication: Not required

Success Response (200):

[
  {
    "id": 10,
    "date_created": "2024-01-15 14:30:00",
    "date_created_gmt": "2024-01-15 11:30:00",
    "review": "Great product, very satisfied!",
    "reviewer": "John Smith",
    "reviewer_name": "John Smith",
    "reviewer_email": "[email protected]",
    "reviewer_avatar_url": "https://gravatar.com/avatar/...",
    "rating": 5,
    "verified": true
  }
]

6. Submit Review

Adds a new review to a product.

Endpoint: POST /magicui/v1/products/{id}/reviews

Authentication: Bearer Token required

Request Body:

{
  "rating": 5,
  "review": "Great product!",
  "reviewer_name": "John Smith"
}

Success Response (200):

{
  "success": true,
  "comment_id": 15,
  "message": "Review submitted successfully."
}

🛒 Order Endpoints

1. Order List

Lists user's orders.

Endpoint: GET /magicui/v1/orders

Authentication: Bearer Token required

Success Response (200):

[
  {
    "id": 1001,
    "order_number": "1001",
    "status": "completed",
    "date_created": "2024-01-15 10:30:00",
    "total": "599.99",
    "currency": "TRY",
    "tracking_info": {
      "company_id": "ups",
      "company_name": "UPS",
      "tracking_number": "123456789",
      "tracking_url": "https://ups.com/track/123456789"
    },
    "line_items": [
      {
        "product_id": 123,
        "variation_id": 0,
        "name": "Sample Product",
        "quantity": 2,
        "price": "299.99",
        "subtotal": "599.98",
        "image_src": "https://example.com/image.jpg"
      }
    ],
    "billing": {
      "first_name": "John",
      "last_name": "Smith",
      "email": "[email protected]",
      "phone": "+1234567890",
      "address_1": "123 Main St",
      "address_2": "",
      "city": "New York",
      "state": "NY",
      "postcode": "10001",
      "country": "US"
    },
    "shipping": {
      "first_name": "John",
      "last_name": "Smith",
      "address_1": "123 Main St",
      "address_2": "",
      "city": "New York",
      "state": "NY",
      "postcode": "10001",
      "country": "US"
    },
    "return_details": {
      "is_returnable": true,
      "return_deadline": "2024-02-01 10:30:00",
      "return_period_days": 14
    }
  }
]

2. Order Details

Retrieves detailed information about a specific order.

Endpoint: GET /magicui/v1/orders/{id}

Authentication: Bearer Token required

Response: Same format as order list, returns single order.

3. Create Order

Creates a new order.

Endpoint: POST /magicui/v1/orders

Authentication: Bearer Token required

Request Body:

{
  "billing": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 5",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "country": "US"
  },
  "shipping": {
    "first_name": "John",
    "last_name": "Smith",
    "address_1": "123 Main St",
    "address_2": "Apt 5",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "country": "US"
  },
  "line_items": [
    {
      "product_id": 123,
      "variation_id": 0,
      "quantity": 2
    }
  ],
  "shipping_lines": [
    {
      "method_id": "flat_rate:1",
      "method_title": "Standard Shipping",
      "total": "20.00"
    }
  ],
  "coupon_lines": [
    {
      "code": "SAVE20",
      "discount": "50.00"
    }
  ],
  "payment_method": "bacs",
  "payment_method_title": "Bank Transfer"
}

Success Response (200):

{
  "id": 1002,
  "order_number": "1002",
  "status": "pending",
  "total": "599.99",
  "currency": "USD",
  "date_created": "2024-01-25 14:30:00",
  "payment_url": "https://example.com/checkout/order-received/1002/?key=wc_order_xyz",
  "redirect_url": "https://example.com/checkout/order-received/1002/?key=wc_order_xyz",
  "payment_result": {},
  "message": "Order created successfully."
}

Features:

Automatic duplicate order prevention (5 minutes)
Payment gateway integration
Automatic billing and shipping address creation
Stock control
Coupon application

4. Cancel Order

Cancels an order.

Endpoint: PUT /magicui/v1/orders/{id}/cancel

Authentication: Bearer Token required

Success Response (200):

{
  "success": true,
  "message": "Order cancelled successfully.",
  "order": {
    "id": 1002,
    "status": "cancelled"
  }
}

Notes:

Only orders with status "pending", "on-hold", "processing" can be cancelled
Orders with status "completed", "cancelled", "refunded" cannot be cancelled

5. Refund Order

Refunds a completed order.

Endpoint: POST /magicui/v1/orders/{id}/refund

Authentication: Bearer Token required

Success Response (200):

{
  "success": true,
  "message": "Order refunded successfully.",
  "order": {
    "id": 1001,
    "status": "refunded",
    "total_refunded": "599.99"
  }
}

Notes:

Only orders with "completed" status can be refunded
Full refund is processed
Return period is configured in settings (default 14 days)

👤 User Endpoints

1. Update Profile

Updates user profile information.

Endpoint: POST /magicui/v1/user/update

Authentication: Bearer Token required

Request Body:

{
  "first_name": "John",
  "last_name": "Smith",
  "billing": {
    "account_type": "individual",
    "identity_number": "12345678901",
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 5",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "country": "US"
  },
  "shipping": {
    "address_name": "Home Address",
    "first_name": "John",
    "last_name": "Smith",
    "address_1": "123 Main St",
    "address_2": "Apt 5",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "country": "US",
    "phone": "+1234567890"
  }
}

Success Response (200):

{
  "success": true,
  "message": "Profile updated successfully.",
  "user": {
    "id": 1,
    "username": "john",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Smith",
    "full_name": "John Smith"
  }
}

Notes:

For billing address, account_type can be "individual" or "corporate"
Individual accounts require identity_number (National ID)
Corporate accounts require tax_id_number (Tax ID) and company_name

2. Get User Info

Retrieves detailed information about the current user.

Endpoint: GET /magicui/v1/user/me

Authentication: Bearer Token required

Success Response (200):

{
  "id": 1,
  "email": "[email protected]",
  "username": "john",
  "first_name": "John",
  "last_name": "Smith",
  "full_name": "John Smith",
  "role": "customer",
  "billing": {
    "first_name": "John",
    "last_name": "Smith",
    "company": "",
    "address_1": "123 Main St",
    "address_2": "Apt 5",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "country": "US",
    "email": "[email protected]",
    "phone": "+1234567890",
    "account_type": "individual",
    "identity_number": "12345678901",
    "tax_id_number": "",
    "company_name": ""
  },
  "shipping": {
    "first_name": "John",
    "last_name": "Smith",
    "company": "",
    "address_1": "123 Main St",
    "address_2": "Apt 5",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "country": "US",
    "address_name": "Home Address"
  },
  "avatar_url": "https://example.com/avatar.jpg"
}

3. Change Password

Changes user's password.

Endpoint: POST /magicui/v1/user/password

Authentication: Bearer Token required

Request Body:

{
  "new_password": "NewSecurePassword123"
}

Success Response (200):

{
  "success": true,
  "message": "Password updated successfully."
}

Notes:

Password must be at least 6 characters
Current token remains valid after password change

4. Reset Password

Password reset via email.

Endpoint: POST /magicui/v1/user/reset_password

Authentication: Not required

Request Body:

{
  "email": "[email protected]"
}

Success Response (200):

{
  "success": true,
  "message": "Password reset successfully. Check your email."
}

Notes:

Generates a random 8-character password
New password is sent to user's email address

5. Upload Avatar

Uploads user profile picture.

Endpoint: POST /magicui/v1/user/avatar

Authentication: Bearer Token required

Content-Type: multipart/form-data

Form Data:

avatar: [image file]

Success Response (200):

{
  "success": true,
  "message": "Avatar uploaded successfully.",
  "avatar_id": 789,
  "avatar_url": "https://example.com/uploads/avatar.jpg",
  "avatar_urls": {
    "full": "https://example.com/uploads/avatar.jpg",
    "96": "https://example.com/uploads/avatar-96x96.jpg",
    "150": "https://example.com/uploads/avatar-150x150.jpg"
  }
}

Supported Formats:

JPEG/JPG
PNG
GIF
WebP

Maximum File Size: 5MB

6. Get Avatar

Retrieves user's current avatar information.

Endpoint: GET /magicui/v1/user/avatar

Authentication: Bearer Token required

Success Response (200):

{
  "has_custom_avatar": true,
  "avatar_id": 789,
  "avatar_url": "https://example.com/uploads/avatar.jpg",
  "avatar_urls": {
    "full": "https://example.com/uploads/avatar.jpg",
    "96": "https://example.com/uploads/avatar-96x96.jpg",
    "150": "https://example.com/uploads/avatar-150x150.jpg"
  }
}

7. Favorites

Get Favorites List

Endpoint: GET /magicui/v1/user/favorites

Authentication: Bearer Token required

Success Response (200):

{
  "success": true,
  "favorites": [123, 456, 789],
  "count": 3
}

Add/Remove Favorite

Endpoint: POST /magicui/v1/user/favorites

Authentication: Bearer Token required

Request Body:

{
  "product_id": 123
}

Success Response (200):

{
  "success": true,
  "action": "added",
  "is_favorite": true,
  "message": "Product added to favorites."
}

8. Update Device ID (Push Notifications)

Registers OneSignal device ID.

Endpoint: POST /magicui/v1/user/device-id

Authentication: Bearer Token required

Request Body:

{
  "device_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Success Response (200):

{
  "success": true,
  "message": "Device ID updated successfully.",
  "device_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

⚙️ Configuration and Other Endpoints

1. App Configuration

Retrieves app settings and configuration.

Endpoint: GET /magicui/v1/config

Authentication: API Key (Header: X-API-Key)

Success Response (200):

{
  "woocommerce": {
    "base_url": "https://example.com",
    "api_version": "wc/v3",
    "consumer_key": "ck_xxxxxxxxxxxxx",
    "consumer_secret": "cs_xxxxxxxxxxxxx",
    "currency_code": "USD",
    "currency_symbol": "$",
    "currency_position": "left",
    "price_thousand_sep": ",",
    "price_decimal_sep": ".",
    "price_num_decimals": 2,
    "store_location": {
      "default_country": "US",
      "address_1": "123 Main St",
      "address_2": "",
      "city": "New York",
      "postcode": "10001"
    }
  },
  "onesignal": {
    "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "app_name": "Magic UI Store",
  "whatsapp": {
    "default_number": "+1234567890"
  },
  "blog": {
    "enabled": true
  },
  "reviews": {
    "enabled": true
  },
  "exchange_rates": {
    "enabled": false,
    "target_currency": "EUR",
    "target_currency_symbol": "€",
    "exchange_rate": 1.0
  },
  "default_language": "en",
  "default_theme": "light",
  "available_languages": ["en", "tr", "de", "ru"],
  "tax": {
    "enabled": true,
    "prices_include_tax": true,
    "rate": 10.0,
    "name": "VAT"
  },
  "bank_transfer": {
    "enabled": true,
    "title": "Bank Transfer",
    "description": "Make payment directly to our bank account.",
    "instructions": "Please include your order number in the payment reference.",
    "account_holder": "Company Name",
    "bank_name": "Sample Bank",
    "iban": "US00 0000 0000 0000 0000 0000 00",
    "accounts": [
      {
        "account_holder": "Company Name",
        "bank_name": "Sample Bank",
        "iban": "US00 0000 0000 0000 0000 0000 00",
        "account_number": "12345678",
        "sort_code": "",
        "bic": "BANKUS00"
      }
    ]
  },
  "checkout": {
    "enabled": true,
    "popup": {
      "enabled": true,
      "style": "bottom-sheet",
      "show_close_button": true,
      "show_header": true
    },
    "payment_methods": [
      {
        "id": "bacs",
        "title": "Bank Transfer",
        "description": "Make payment directly to our bank account."
      }
    ],
    "shipping": {
      "enabled": true,
      "force_shipping": false
    },
    "coupons_enabled": true,
    "guest_checkout": false,
    "terms_and_conditions": {
      "enabled": true,
      "page_id": "123"
    }
  }
}

2. Home Page Data

Retrieves banners and categories for home page.

Endpoint: GET /magicui/v1/home

Authentication: Not required

Success Response (200):

{
  "ok": true,
  "banners": [
    {
      "id": 1,
      "image": "https://example.com/banner1.jpg",
      "link": "https://example.com/campaign",
      "title": "Summer Sale",
      "order": 0
    }
  ],
  "featured_categories": [
    {
      "id": 15,
      "kategori_id": 15,
      "name": "Electronics",
      "kategori_adi": "Electronics",
      "image": "https://example.com/category.jpg",
      "count": 45,
      "parent_id": 0
    }
  ],
  "all_categories": [
    {
      "id": 15,
      "kategori_id": 15,
      "name": "Electronics",
      "kategori_adi": "Electronics",
      "image": "https://example.com/category.jpg",
      "count": 45,
      "parent_id": 0
    }
  ]
}

3. Payment Gateways

Lists active payment methods.

Endpoint: GET /magicui/v1/payment-gateways

Authentication: Bearer Token required

Success Response (200):

[
  {
    "id": "bacs",
    "title": "Bank Transfer",
    "method_title": "Direct bank transfer",
    "description": "Make payment directly to our bank account.",
    "enabled": true,
    "method_description": "Customers pay directly into your bank account.",
    "account_details": [
      {
        "account_name": "Company Name",
        "account_number": "12345678",
        "bank_name": "Sample Bank",
        "sort_code": "",
        "iban": "US00 0000 0000 0000 0000 0000 00",
        "bic": "BANKUS00"
      }
    ],
    "instructions": "Please include your order number in the payment reference."
  }
]

4. Shipping Zones

Lists WooCommerce shipping zones.

Endpoint: GET /magicui/v1/shipping-zones

Authentication: Bearer Token required

Success Response (200):

[
  {
    "id": 1,
    "name": "United States",
    "order": 0
  },
  {
    "id": 0,
    "name": "Other Regions",
    "order": 0
  }
]

5. Shipping Methods

Lists shipping methods for a specific zone.

Endpoint: GET /magicui/v1/shipping-zones/{zone_id}/methods

Authentication: Bearer Token required

Success Response (200):

[
  {
    "id": 1,
    "method_id": "flat_rate",
    "method_title": "Standard Shipping",
    "title": "Standard Shipping",
    "enabled": true,
    "cost": "20",
    "description": "Standard delivery",
    "settings": {
      "cost": "20",
      "title": "Standard Shipping"
    }
  }
]

6. Validate Coupon

Validates coupon code.

Endpoint: GET /magicui/v1/validate-coupon?code=SAVE20

Authentication: Bearer Token required

Query Parameters:

Parameter

Type

Description

code

string

Coupon code

Success Response (200):

{
  "id": 123,
  "code": "SAVE20",
  "amount": "20",
  "discount_type": "percent",
  "description": "20% discount coupon",
  "date_expires": "2024-12-31 23:59:59",
  "usage_count": 45,
  "usage_limit": 100,
  "minimum_amount": "100.00",
  "maximum_amount": "1000.00",
  "individual_use": false,
  "exclude_sale_items": false
}

Discount Types:

percent - Percentage discount
fixed_cart - Fixed amount for cart
fixed_product - Fixed amount for product

7. Locations (Countries and States)

Lists all countries and states.

Endpoint: GET /magicui/v1/locations

Authentication: Not required

Success Response (200):

[
  {
    "code": "US",
    "name": "United States",
    "states": [
      {
        "code": "CA",
        "name": "California"
      },
      {
        "code": "NY",
        "name": "New York"
      }
    ]
  },
  {
    "code": "GB",
    "name": "United Kingdom",
    "states": []
  }
]

8. Privacy Policy

Retrieves app privacy policy.

Endpoint: GET /magicui/v1/privacy

Authentication: Not required

Success Response (200):

{
  "title": "Privacy Policy",
  "content": "Privacy policy text...",
  "content_html": "<p>Privacy policy text...</p>",
  "last_updated": "January 25, 2024"
}

9. Terms of Use

Retrieves app terms of use.

Endpoint: GET /magicui/v1/terms

Authentication: Not required

Success Response (200):

{
  "title": "Terms of Use",
  "content": "Terms of use text...",
  "content_html": "<p>Terms of use text...</p>",
  "last_updated": "January 25, 2024"
}

10. Health Check

Returns API status and version information.

Endpoint: GET /magicui/v1/health

Authentication: Not required

Success Response (200):

{
  "status": "ok",
  "version": "1.0.0",
  "wordpress_version": "6.4.2",
  "woocommerce_active": true,
  "woocommerce_version": "8.5.1"
}

🔒 Security

JWT Token Security

Token Storage: Store token securely (iOS Keychain, Android KeyStore)
HTTPS: Make all API requests over HTTPS
Token Refresh: Refresh token before expiration
Token Revocation: Delete token on logout

Error Handling

All error responses follow this format:

{
  "code": "error_code",
  "message": "Error message",
  "data": {
    "status": 400
  }
}

HTTP Status Codes

Code

Description

200

Success

201

Created

400

Bad Request

401

Unauthorized (Invalid/missing token)

403

Forbidden (No permission)

404

Not Found

500

Server Error

📱 Special Features

1. Push Notifications

OneSignal integration
Automatic notifications on order status changes
Custom notification sending (from Admin panel)

2. Return Management

Automatic return eligibility check
Configurable return period
Calculation based on order completion date

3. Duplicate Order Prevention

5-minute temporary cache
Hash-based order verification
Automatic existing order return

4. Multi-language Support

Supported languages:

Turkish (tr)
English (en)
German (de)
Russian (ru)
Portuguese (pt)
Arabic (ar)
French (fr)
Spanish (es)
Hindi (hi)
Chinese (zh)

🎯 Best Practices

1. Token Management

// Save token
localStorage.setItem('jwt_token', response.token);

// Add token to every request
const headers = {
  'Authorization': `Bearer ${localStorage.getItem('jwt_token')}`,
  'Content-Type': 'application/json'
};

// Check token validity
async function checkTokenValidity() {
  const response = await fetch('/wp-json/jwt-auth/v1/token/validate', {
    method: 'POST',
    headers: headers
  });
  
  if (!response.ok) {
    // Token invalid, redirect to login
    redirectToLogin();
  }
}

2. Error Handling

async function apiRequest(endpoint, options) {
  try {
    const response = await fetch(endpoint, options);
    const data = await response.json();
    
    if (!response.ok) {
      throw new Error(data.message || 'An error occurred');
    }
    
    return data;
  } catch (error) {
    console.error('API Error:', error);
    // Show error to user
    showErrorToUser(error.message);
  }
}

3. Pagination

async function loadProducts(page = 1) {
  const response = await apiRequest(
    `/wp-json/magicui/v1/products?page=${page}&per_page=20`,
    { headers }
  );
  
  return {
    products: response.data,
    totalPages: response.pages,
    currentPage: response.page
  };
}

📞 Support

For questions:

Email: [email protected]
Linkedin: https://www.linkedin.com/in/suleymanekici/

Note: This API is continuously being developed. Check the documentation regularly for updates.

PreviousWooCommerce Hooks NextReact Native App Installation

Last updated 1 month ago

Was this helpful?

Good afternoon

hashtagBase URL

hashtagAuthentication

hashtagHow to Get a Token?

hashtag🔐 Authentication Endpoints

hashtag1. Generate Token (Login)

hashtag2. Token Validation

hashtag3. Token Refresh

hashtag👤 User Registration

hashtagRegister New User

hashtag🛍️ Product Endpoints

hashtag1. Product List

hashtag2. Product Details

hashtag3. Product Variations

hashtag4. Categories

hashtag5. Product Reviews

hashtag6. Submit Review

hashtag🛒 Order Endpoints

hashtag1. Order List

hashtag2. Order Details

hashtag3. Create Order

hashtag4. Cancel Order

hashtag5. Refund Order

hashtag👤 User Endpoints

hashtag1. Update Profile

hashtag2. Get User Info

hashtag3. Change Password

hashtag4. Reset Password

hashtag5. Upload Avatar

hashtag6. Get Avatar

hashtag7. Favorites

hashtag8. Update Device ID (Push Notifications)

hashtag⚙️ Configuration and Other Endpoints

hashtag1. App Configuration

hashtag2. Home Page Data

hashtag3. Payment Gateways

hashtag4. Shipping Zones

hashtag5. Shipping Methods

hashtag6. Validate Coupon

hashtag7. Locations (Countries and States)

hashtag8. Privacy Policy

hashtag9. Terms of Use

hashtag10. Health Check

hashtag🔒 Security

hashtagJWT Token Security

hashtagError Handling

hashtagHTTP Status Codes

hashtag📱 Special Features

hashtag1. Push Notifications

hashtag2. Return Management

hashtag3. Duplicate Order Prevention

hashtag4. Multi-language Support

hashtag🎯 Best Practices

hashtag1. Token Management

hashtag2. Error Handling

hashtag3. Pagination

hashtag📞 Support

Base URL

Authentication

How to Get a Token?

🔐 Authentication Endpoints

1. Generate Token (Login)

2. Token Validation

3. Token Refresh

👤 User Registration

Register New User

🛍️ Product Endpoints

1. Product List

2. Product Details

3. Product Variations

4. Categories

5. Product Reviews

6. Submit Review

🛒 Order Endpoints

1. Order List

2. Order Details

3. Create Order

4. Cancel Order

5. Refund Order

👤 User Endpoints

1. Update Profile

2. Get User Info

3. Change Password

4. Reset Password

5. Upload Avatar

6. Get Avatar

7. Favorites

8. Update Device ID (Push Notifications)

⚙️ Configuration and Other Endpoints

1. App Configuration

2. Home Page Data

3. Payment Gateways

4. Shipping Zones

5. Shipping Methods

6. Validate Coupon

7. Locations (Countries and States)

8. Privacy Policy

9. Terms of Use

10. Health Check

🔒 Security

JWT Token Security

Error Handling

HTTP Status Codes

📱 Special Features

1. Push Notifications

2. Return Management

3. Duplicate Order Prevention

4. Multi-language Support

🎯 Best Practices

1. Token Management

2. Error Handling

3. Pagination

📞 Support