Duoplane API
  1. Duoplane API overview
Duoplane API
  • Duoplane API overview
    • Access and authentication
    • Request and response basics
    • Rate limiting
  • API reference
    • Order management
      • Orders
        • The Order object
        • Create an order
        • Get an order
    • Product and inventory management
      • Products
        • The Product object
        • Create a product
        • Get a single product
      • Product Inventories
        • The ProductInventory object
  1. Duoplane API overview

Access and authentication

Authentication#

Access to the API is authenticated using HTTP Basic Authentication.
All API requests must be made over HTTPS.

API users#

An API user's API Key and Password are used to authenticate each API request.
You must be an Admin in order to manage API users for your account.

How to create an API user#

1.
In your Duoplane account, go to Settings > Staff Members.
2.
Scroll to the bottom of the page and click "Manage API users"
3.
Click "Add an API user"
4.
Give the API user a name that indicates its purpose. For example: "ERP Integration".
5.
Click "Save" to save the new user.
6.
After the API user is saved, you will see 2 pieces of information that you will need for authentication.
API Key: This will be used as the username for your HTTP authentication.
API Password: This will be used as the password for your HTTP authentication. Please note that this password will only be displayed once
Important: Note that the API Password will not be displayed again after you navigate away from this page. So record the password someplace secure before leaving this page.

How to generate a new password for an existing API user#

1.
In your Duoplane account, go to Settings > Staff Members.
2.
Scroll to the bottom of the page and click "Manage API users"
3.
Click "Edit" on the line of the API user.
4.
Click "Regenerate password".
5.
Click "Save" to save the new user.
6.
Copy the new password to a secure location.
Modified at 2024-10-07 17:42:00
Next
Request and response basics
Built with