Extracting Employee Data with the BambooHR API - Practical Examples.

Apideck Documentation Page

How to Connect to Etsy

Etsy is an e-commerce website focused on handmade or vintage items and craft supplies. This guide will walk you through the process of connecting your Etsy shop to Apideck's Unified API.

Prerequisites

Before you begin, make sure you have:

  1. An active Etsy account with a shop
  2. Your Etsy shop name
  3. Your OAuth redirect URI: https://unify.apideck.com/vault/callback

Register your OAuth application

1. Create a new application

  1. Go to the Etsy Developer Portal
  2. Fill in the required fields:
    • Name: Enter a name for your application (typically your company name)
    • Description: Provide a description of what your application does
    • Who will be the users of this application?: Select the option that best matches your use case
    • Is your application commercial?: Select the appropriate option
  3. Complete the captcha verification and click "Read Terms and Create App"

Etsy - Register Application

2. Configure your application

  1. After creating your app, navigate to Manage your apps on Etsy's developer page
  2. Find your application in the list and click on it
  3. In the app details page:
    • Set your Website URL to your company website
    • Click on "Edit your callback URLs"
    • Add 
      https://unify.apideck.com/vault/callback
      as a callback URL
    • Click "Save Changes"

Etsy - Configure Callback URLs

3. Get your API credentials

  1. On the Manage your apps page, find your application
  2. Click on the plus sign next to "SEE API KEY DETAILS"
  3. Copy your Keystring (Client ID) and Shared Secret (Client Secret)

Etsy - API Key Details

4. API Key Approval Process

Important: Your API key must go through Etsy's approval process before it can be used. Here's what you need to know:

  • Approval Status: You can check the status of your API key under the "See API Key Details" dropdown in the "Manage Your Apps" section. Look for the "Status" field.
  • Approval Timeline: The approval process typically takes around 30 days, but may take longer during busy periods or if additional information is needed.
  • Testing During Approval: While waiting for approval for commercial use, you can still use the API key with personnel access with limited functionality and rate limits which should be sufficient for integration.
  • Approval Criteria: Etsy reviews applications to ensure they comply with their API Terms of Use.
  • Rejection Reasons: Applications may be rejected if they:
    • Have incomplete or inaccurate information
    • Violate Etsy's terms of use or policies
    • Duplicate existing functionality without adding value
    • Pose security or privacy risks to Etsy users
  • If Rejected: If your application is rejected, Etsy will typically provide feedback on why. You can make the necessary changes and resubmit for approval.
  • Production Limits: Once approved for commercial use, your API key will have higher rate limits and full access to the API endpoints based on the scopes you request.

For commercial applications, Etsy may require additional verification steps or documentation before granting approval.

How to Find Your Etsy Shop Name

Your Etsy shop name is an essential piece of information needed to connect to the Etsy API. Here's how to find it:

Method 1: From Your Etsy Shop URL

  1. Log in to your Etsy account
  2. Navigate to your shop by clicking on "Shop Manager" in the top navigation bar Etsy Shop Manager
  3. Click at the URL on the top of the page. It will be in this format: 
    apideck.etsy.com
    Etsy Shop Access URL
  4. Now you can copy your Shop Name from the URL shown in the browser.

Etsy Shop URL

Method 2: From Shop Settings

  1. Log in to your Etsy account
  2. Click on "Shop Manager" in the top navigation bar Etsy Shop Manager
  3. In the left sidebar, click on "Settings"
  4. Click on "Info & Appearance"
  5. Your shop name will be displayed at the top of the page

Etsy Shop Settings

Configure the Etsy Connector in Apideck

  1. Enter the credentials you obtained from Etsy:

    • Client ID: Your Etsy App API Key (Keystring)
    • Client Secret: Your Etsy Shared Secret

  2. Enter your Shop Name in the designated field Etsy Connection Settings

  3. Click "Save" to store your settings

  4. Click "Authorize" and complete the flow to establish the connection

  5. Select your Shop ID from the dropdown and click on "Save"

Verify the Connection

After connecting, you should see a "Connected" status in the Apideck dashboard. You can now use the Etsy connector with Apideck's Unified API.

Troubleshooting

Connection Issues

If you encounter issues connecting to Etsy:

  1. Verify that your Shop Name is entered correctly (it's case-sensitive)
  2. Ensure your Etsy shop is active and in good standing
  3. Check that you have the necessary permissions to access your shop's data