Back
4 min read

.do SDK vs. Direct API Calls: Which Should You Choose for .do Platform Integration?

Integrating with the .do platform opens up a world of possibilities, from automating complex workflows with agentic AI to building custom solutions that connect your services. When it comes to interacting with the .do platform programmatically, you generally have two main approaches: using the official .do Software Development Kit (SDK) or making direct API calls. But which method is right for your project? Let's dive into the pros and cons of each.

Understanding the .do Platform and Integration

The .do platform is designed to empower businesses to build and automate processes using "business as code" and "services as software" principles. At its core lies a powerful API that allows external applications to interact with its capabilities. This is where both the SDK and direct API calls come in.

The .do SDK: Develop with Ease

The .do SDK is a library provided by the .do team specifically designed to simplify integration. Think of it as a pre-built toolkit that handles much of the heavy lifting for you.

import { DoSDK } from '@do/sdk';

const sdk = new DoSDK({
  apiKey: 'YOUR_API_KEY',
});

// Example: Fetch available agents
async function listAgents() {
  try {
    const agents = await sdk.agents.list();
    console.log('Available Agents:', agents);
  } catch (error) {
    console.error('Error listing agents:', error);
  }
}

listAgents();

As you can see in the example above, using the SDK makes interacting with the platform's features, like fetching available agents, straightforward and intuitive.

Pros of Using the .do SDK:

  • Simplified Development: The SDK abstracts away low-level details like constructing URLs, handling HTTP requests, serializing/deserializing data, and managing authentication. This significantly speeds up development time.
  • Type Safety and Auto-completion: For languages like TypeScript, the SDK often provides type definitions, leading to better code maintainability, fewer errors, and helpful auto-completion in your IDE.
  • Consistent Interface: The SDK provides a consistent and well-documented interface for interacting with different parts of the platform, reducing the learning curve.
  • Built-in Error Handling: SDKs often include built-in error handling and retry mechanisms, making your integrations more robust.
  • Version Management: Updates to the API are often reflected in new SDK versions, providing a clearer path for upgrading your integration.

Cons of Using the .do SDK:

  • Dependency: You introduce a dependency on an external library in your project.
  • Potential Lag in Updates: While the SDK aims to keep pace with API changes, there might be a slight delay between a new API feature being released and its inclusion in the SDK.
  • Limited Customization: If you need to perform highly specific or unconventional interactions with the API, the SDK might not offer the exact functionality you need, potentially requiring a fallback to direct API calls for those specific edge cases.

Direct API Calls: Maximum Flexibility

Making direct API calls involves constructing and sending HTTP requests directly to the .do platform's API endpoints. This requires a deeper understanding of the API documentation and the underlying web technologies.

Pros of Making Direct API Calls:

  • Maximum Flexibility and Control: You have granular control over every aspect of the request and response, allowing for highly customized interactions.
  • Access to Latest Features Immediately: You can immediately utilize any new API endpoints or features as soon as they are documented, without waiting for an SDK update.
  • Language Agnostic: You can use any programming language or tool that can make HTTP requests.

Cons of Making Direct API Calls:

  • Increased Development Complexity: You need to manually handle request construction, serialization, authentication, error handling, and response parsing. This is more time-consuming and error-prone.
  • Boilerplate Code: You'll often need to write repetitive code for common tasks like setting headers, handling authentication, and parsing JSON responses.
  • Higher Learning Curve: Requires a thorough understanding of the .do platform API documentation and general API principles.
  • More Difficult to Maintain: As the API evolves, you'll need to manually update your code to reflect changes, which can be more complex without the structure provided by an SDK.

Which Should You Choose?

The decision between using the .do SDK and making direct API calls depends largely on your project's needs, your team's expertise, and the desired level of control.

  • For most developers building typical integrations and applications, the .do SDK is the recommended choice. Its ease of use, simplified development process, and built-in features significantly reduce development time and increase code quality. It's ideal for quickly building custom solutions and automating workflows.
  • If you require highly specific or low-level control over API interactions, are working in a language not well-supported by the SDK, or need immediate access to brand new API features before they are incorporated into the SDK, direct API calls might be necessary. However, be prepared for the increased development effort and maintenance overhead.

In some cases, a hybrid approach might even be beneficial, using the SDK for most interactions and making direct calls for specific edge cases.

Getting Started with the .do SDK

Ready to start building with the .do SDK? Getting started is simple.

The .do SDK is available via popular package managers like npm and yarn. You can find detailed installation instructions and comprehensive documentation on our developer portal, guiding you through connecting to the .do platform and leveraging its capabilities to the fullest.

Frequently Asked Questions

What is the .do SDK?

The .do SDK allows developers to programmatically interact with the .do platform, enabling them to build custom applications, automate workflows, and integrate with existing services.

How do I get started with the .do SDK?

You can install the .do SDK via npm or yarn package managers. Detailed installation instructions and documentation are available on our developer portal.

What programming languages does the .do SDK support?

The .do SDK is designed to be used with a variety of programming languages. We primarily provide examples and support for TypeScript/JavaScript, but the underlying API can be accessed from any language capable of making HTTP requests.

Conclusion

Both the .do SDK and direct API calls provide pathways to integrate with the powerful .do platform. While direct API calls offer maximum flexibility, the .do SDK stands out as the more efficient and developer-friendly option for the majority of integration scenarios. By abstracting away complexity and providing a streamlined interface, the SDK empowers you to focus on building innovative solutions and unlocking the full potential of agentic AI and workflow automation within your applications. Choose the SDK to accelerate your development and easily connect with the .do platform.

Do Work. With AI.

Join WaitlistLearn more
.do SDK vs. Direct API Calls%3A Which Should You Choose