Official SDKs
TypeScript
Server-side and browser SDK clients
Python
Server-side SDK for backend integrations
Java
Server-side SDK for JVM-based applications
TypeScript SDK
The TypeScript SDK can be used in both browser and server environments, enabling you to build full-stack applications with Pipedream Connect.Installation
To install the SDK from npm, run:<script>
tag. You can run the latest version:
Server Usage
Most of your interactions with the Connect API will likely happen on the server, to protect API requests and user credentials. You’ll use the SDK in your frontend to let users connect accounts. Once connected, you’ll use the SDK on the server to retrieve account info, invoke workflows on their behalf, and more.Browser Usage
You’ll primarily use the browser client to let your users securely connect apps from your frontend. When making calls from the browser, you’ll use short-lived Connect tokens to authenticate requests.- Create a short-lived Connect token on your server
- Initiate auth with that token to securely connect an account for a specific user
Python SDK
The Python SDK is for server-side use. Install it to build backend services and APIs that interact with Pipedream Connect as part of your full-stack application.Installation
To install the SDK from pip, run:Usage
Java SDK
The Java SDK is for server-side use in JVM-based applications. Use it to build Java backends, Spring Boot applications, and other JVM services that integrate with Pipedream Connect.Installation
To install the SDK with Maven, add this dependency to yourpom.xml
:
build.gradle
:
Usage
Like the Python SDK, the Java SDK is designed for server-side applications. Use it to securely manage user connections, retrieve account info, and interact with the Connect API from your Java backend.Postman Collection
Postman Collection
Use Pipedream’s Postman Collection to explore and test the Connect API
OpenAPI Specification
OpenAPI Specification
Explore Pipedream’s OpenAPI specification to see the full list of endpoints and parameters