Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Connect UI Documentation #3107

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
woocommerce docs
  • Loading branch information
dannylwe committed Dec 3, 2024
commit 9ff4c135315984585c7f668b6f62ae72513ed887
6 changes: 5 additions & 1 deletion docs-v2/integrations/all/woocommerce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,8 @@ API configuration: [`woocommerce`](https://nango.dev/providers.yaml)
- Woocommerce uses `Basic` auth mode to access different endpoints. Provide your `consumer key` as the Username value and `consumer secret` as the Password value.
- When creating a new connection, please add your `storeURL`.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/woocommerce.mdx)</Note>
<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/woocommerce.mdx)</Note>

<Card title="Connect to Woocommerce" icon="link" href="/integrations/all/woocommerce/connect" horizontal>
Guide to connect to Woocommerce using Nango Connect.
</Card>
56 changes: 56 additions & 0 deletions docs-v2/integrations/all/woocommerce/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Woocommerce - How do I link my account?
sidebarTitle: Woocommerce
---


# Overview

To authenticate with Woocommerce, you need two key pieces of information:
1. **Consumer key** - Your unique account identifier
2. **Consumer secret** - Secert key associated with Consumer key


This guide will walk you through finding or creating those credentials within Woocommerce.


### Prerequisites:

- You must set up an Woocommerce on a Wordpress instance.


#### Step 1: Finding Your Woocommerce Consumer Key
1. Log into your Wordpress instance with admin access and navigate to `Woocommerce` on the left panel and
navigate to `WooCommerce` > `Settings` > `Advanced` > `REST API`.

<img src="/integrations/all/woocommerce/woo_1.png" />

2. Click the "Add Key" button. In the next screen, add a description and select the WordPress user you would like to generate the key for.
3. Choose the level of access for this REST API key, which can be Read access, Write access or Read/Write access. Then click the "Generate API Key"
button and WooCommerce will generate keys for the selected user.
4. Copy your `Consumer Key`.

<img src="/integrations/all/woocommerce/woo_2.png" />


#### Step 2: Finding Your Woocommerce Consumer Secret
1. From the previous step, securely store your `Consumer secret` key.


<img src="/integrations/all/woocommerce/woo_3.png" />


Important: Copy and store your Consumer Key securely, it will not be visible again once you leave this page.


#### Step 3: Connect Your Woocommerce Account

<img src="/integrations/all/woocommerce/nango_connect_ui.png" />

To authenticate using your API credentials, navigate to the Woocommerce authentication form.
Enter your credentials as follows:
- User Name: Your Consumer key
- Password: Your Consumer secret
- Domain: Your Wordpress intance domain

Click "Connect" to complete the authentication.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/woocommerce/woo_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/woocommerce/woo_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/woocommerce/woo_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions packages/shared/providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6526,6 +6526,7 @@ woocommerce:
method: GET
endpoint: /wp-json/wc/v3/customers
docs: https://docs.nango.dev/integrations/all/woocommerce
docs_connect: https://docs.nango.dev/integrations/all/woocommerce/connect
connection_config:
storeURL:
type: string
Expand Down