Estimated time to complete: 3 minutes
This guide will walk you through the process of integrating your WooCommerce store with your YouPurr marketplace/s using the WooCommerce REST API.
Some aspects and visuals of this guide may differ due to the time of documenting.
What you will require
- •An active WooCommerce store on WordPress.
- •Admin access to your WordPress dashboard.
- •Your marketplace contact details (to securely share your API credentials).
Let's get started!
Step 1: Navigate to REST API
- •
Log in to your WordPress dashboard.
- •
Go to WooCommerce > Settings > Advanced > REST API.
Step 2: Add a New Key
- •Click the 'Add Key' (or 'Create an API Key') button.
Step 3: Configure Key Details
- •
Description: Enter "YouPurr" as the description name.
- •
User: Select the user who will be associated with this key.
Best Practice: It is often recommended to create a separate user account specifically for an API connection (e.g., a user named "YouPurr") for the following reasons:
- •Audit Trail: It makes it easier to see exactly which app made specific changes in your store logs.
- •Security: If a specific service is compromised, you can delete that single user or revoke their key without affecting your own admin access.
- •Role Management: You can assign this new user a specific role, like Shop Manager, to ensure the API only has access to what it needs and nothing more.
Step 4: Permissions
Select Read/Write permissions. YouPurr requires both access levels:
- •Read: YouPurr needs to read your products, inventory, and order data to display accurate information on your marketplace.
- •Write: YouPurr needs write access to create and manage orders that come through your marketplace.
For reference, here are the full access levels available:
- •Read: View data only.
- •Write: Edit or create data.
- •Read/Write: Full access to view and modify data.
Step 5: Generate the Key
- •Click the 'Generate API Key' button.
Step 6: Share Your Credentials
- •Securely send this API Key to your marketplace contact.
Crucial Security Note
Once the keys are generated, WooCommerce will display a Consumer Key and a Consumer Secret. Copy these immediately to a secure location (like a password manager) because the secret key will be hidden forever as soon as you leave the page.
Congratulations!
You can now sell through YouPurr Marketplaces!
Please ensure you have securely shared your API credentials with your marketplace contact. Once they confirm the integration is complete, your products will be available on the marketplace.