SDKs & Libraries

Benefits of Using Our SDKs

While you can directly interact with our REST API using HTTP clients, our SDKs provide several advantages that can significantly improve your development experience:

Type Safety & Code Completion

Our SDKs provide type definitions for request parameters and response data, enabling code completion in your IDE and catching potential errors at compile time.

Authentication Handling

The SDKs manage authentication details automatically, including token refresh, secure storage, and handling of various authentication methods.

Robust Error Handling

SDKs translate API errors into language-specific exceptions or error types with helpful messages and context, making them easier to handle in your code.

Automatic Retries

Built-in retry logic for transient failures, with configurable backoff strategies to handle network issues and rate limiting gracefully.

Idiomatic Interfaces

Each SDK follows the conventions and patterns of its respective language, making it feel natural and intuitive to developers familiar with that ecosystem.

Framework Integrations

Many of our SDKs include integrations with popular frameworks, making it even easier to incorporate MyAppAPI into your application architecture.

Available SDKs

We currently offer the following official SDKs:

JavaScript/Node.js

Our JavaScript SDK supports both browser and Node.js environments with TypeScript definitions for enhanced developer experience.

TypeScript support Promise-based API Async/await friendly Browser & Node.js Framework plugins

v2.8.0

Node.js 14+ / ES6+ browsers

Documentation GitHub npm install @myappapi/sdk

Python

Modern Python SDK with full type annotations, asyncio support, and comprehensive test coverage for reliable integration.

Type annotations Async/await support Context managers Django integration Flask integration

v1.9.2

Python 3.7+

Documentation GitHub pip install myappapi

Ruby

Ruby SDK with a focus on clean, idiomatic Ruby code, extensive documentation, and Rails integration for seamless development.

Ruby idioms Rails integration ActiveSupport compatible Middleware support RSpec helpers

v3.2.1

Ruby 2.6+

Documentation GitHub gem install myappapi

PHP

Modern PHP SDK with PSR compliance, framework integrations, and comprehensive documentation for PHP applications.

PSR-18 compliant Laravel integration Symfony integration PHP 8.0 attributes Composer ready

v2.4.0

PHP 7.4+

Documentation GitHub composer require myappapi/sdk

Java

Robust Java SDK with fluent builder patterns, comprehensive documentation, and Spring Boot integration for enterprise applications.

Fluent API Spring Boot starter Reactive support Modular design Extensive Javadoc

v1.5.3

Java 8+

Documentation GitHub Maven/Gradle

Go

Idiomatic Go SDK with strong typing, context support, and comprehensive documentation for reliable integration in Go applications.

Context support Concurrency-safe Interface-based design Middleware chains Go 1.18+ generics

v2.1.0

Go 1.16+

Documentation GitHub go get github.com/myappapi/go

.NET / C#

Comprehensive .NET SDK with strong typing, async support, and extensive documentation for all .NET platforms.

Async/await pattern LINQ support DI container integration Cross-platform ASP.NET Core integration

v3.0.1

.NET Standard 2.0+ / .NET 5+

Documentation GitHub dotnet add package MyAppApi.SDK

Swift / iOS

Native Swift SDK for iOS, iPadOS, macOS, and watchOS applications with modern Swift features and Apple platform integrations.

Swift concurrency Combine support SwiftUI compatible Keychain integration Swift Package Manager

v1.2.0

Swift 5.5+ / iOS 13+

Documentation GitHub Swift Package Manager

SDK Versioning

Our SDKs follow semantic versioning (MAJOR.MINOR.PATCH) to indicate the nature of changes in each release:

• MAJOR version changes indicate backwards-incompatible changes
• MINOR version changes add new functionality in a backwards-compatible manner
• PATCH version changes include backwards-compatible bug fixes

All SDKs are versioned independently of each other and the API itself. A new API feature may result in minor version updates across all SDKs, but the timing of these updates may vary.

Version Compatibility

Each SDK version is compatible with specific API versions:

We recommend keeping your SDK up to date with the latest version to benefit from bug fixes, security updates, and new features. For guidance on upgrading, see the migration guides in each SDK's documentation.

Getting Started

To begin using our SDKs, choose your preferred language and follow these steps:

1. Installation

Install the SDK using your language's package manager (npm, pip, gem, etc.) as shown on each SDK card above.

2. Authentication

Configure the SDK with your API credentials. Here's a basic example in JavaScript:

// Initialize the SDK with your API key
const myappapi = new MyAppAPI({
  apiKey: 'YOUR_API_KEY',
  environment: 'production' // or 'sandbox' for testing
});

3. Making API Calls

Start making API calls using the SDK's idiomatic interface:

// Example: Fetch a list of resources
try {
  const resources = await myappapi.resources.list({
    limit: 10,
    status: 'active'
  });
  
  console.log(`Found ${resources.length} resources`);
  
  // Create a new resource
  const newResource = await myappapi.resources.create({
    name: 'My Resource',
    description: 'Created with the SDK',
    type: 'standard'
  });
  
  console.log(`Created resource with ID: ${newResource.id}`);
} catch (error) {
  // SDKs provide rich error information
  console.error(`Error: ${error.message}`);
  
  if (error.isRateLimitError) {
    console.error(`Rate limited. Retry after: ${error.retryAfter} seconds`);
  }
}

For more detailed examples and language-specific guidance, visit the documentation for your chosen SDK.

Community SDKs

In addition to our official SDKs, our community has developed libraries for other languages and frameworks. While not officially maintained by MyAppAPI, these community SDKs can be valuable for developers working with platforms we don't officially support yet.

SDK Support

We're committed to providing excellent support for our official SDKs. If you encounter issues or have questions, there are several ways to get help:

Contributing

Our SDKs are open source, and we welcome contributions from the community. Whether it's fixing a bug, improving documentation, or suggesting new features, your contributions help make our SDKs better for everyone.

To contribute:

1. Fork the repository for the SDK you want to contribute to
2. Create a new branch for your changes
3. Make your changes following the project's code style and conventions
4. Add tests for your changes
5. Submit a pull request with a clear description of your changes

Each SDK repository contains a CONTRIBUTING.md file with specific guidelines for that project. Please review these guidelines before submitting your contribution.

Frequently Asked Questions