A tool 🔑 for developers to unlock data from business portals and make data flow like an aqueduct 🌊

Getting Started

How to get started with PortalDuct APIs and credential collecting 🚀

🔐 1. Create a Token

To start using the API, you'll need an API Token. You can generate your token using your registered email and password and the GET Authentication endpoint.

Note that you will start with the API token for your sandbox, before you move over to production. 🚢.

🏖 2. Build in the Sandbox

The PortalDuct sandbox is a full-featured environment that lets you do everything you can do in production, without grabbing real production data, dealing with real credential information, or worrying about customers and vendors getting emails they shouldn't.

You can develop code against this environment, integrate it with a testing environment in your platform and with stub-responses see your collected data in your platform.

🚀 3. Ship to Production

Once you're happy with the behavior in the sandbox, it's time to ship to production! Many of our customers opt to start with one beta client during the initial launch of their integration to give their team a chance to give a sign off ✍️ before going fully scaled.

Before we dive into the details, we'll show you how to get your integration from sandbox to production with a handy checklist so you know exactly what to expect along the journey...

📚 Key Details on API Management

URLs

Authentication

To access the API you must supply your API token in the Authorization header.

Authorization: Bearer <token>

For instructions on retrieving your token, please navigate in the PortalDuct Customer Developer Portal to the API Credentials tab.

Errors

In general, there are 3 status code ranges you can expect when working with the API:

• 2XX for a successful request
• 4XX indicate an error related to something the client has sent to PortalDuct
• 5XX indicate a problem on PortalDuct's side

Rate Limiting

There are also usage limits enforced by PortalDuct services. By default, PortalDuct limits API requests to 100 per minute. This seems reasonable for most uses of PortalDuct API. If you exceed the rate limit, you will receive a 429 Too Many Requests error. If you need to process lots of requests at once, PortalDuct has a bulk import process that you can utilize with our customer success team.