Skip to main content

The SDK, Integration Template, Sample, and Development Utility

The tools you use to build an iPaaS.com integration: the .NET SDK, the starter template, the sample integration, and the local Development Utility.

An iPaaS.com integration is a .NET (C#) class library compiled into a single assembly (a .dll) that the platform loads and runs. You write your implementation against the iPaaS.com Integration SDK, test it locally, compile it, and upload it to an integration version. The compiled .dll must be under 10 MB.

Development Resources and Tools

All of the following can be found on our GitHub.

The iPaaS.com Integration SDK

The SDK is the library of interfaces and helpers you implement against. It defines the contract between your code and the platform: authentication, data models, mappings, transformation helpers, and the API call wrappers. Keep current with SDK releases, since new versions add capabilities and fixes. See SDK Release Notes & Version History.

The Integration Template

A starter project that scaffolds the required interfaces and structure, so you begin from a working skeleton instead of a blank solution. Use it to create every new integration.

The Sample Integration

A complete, working reference implementation. It shows how a real integration wires up authentication, data models, mappings, and webhooks end to end. Use it as a worked example when you are unsure how a piece should look.

The Development Utility

A local tool for running and testing your integration outside the platform. Use it to execute API calls, inspect request and response payloads, and iterate quickly before uploading a build.

User-controlled implementation

You own the implementation logic. The platform calls your code through the SDK's defined interfaces, which keeps every integration consistent and maintainable while leaving the system-specific behavior to you.

Authentication

The SDK supports common authentication types, including API key, Basic, and OAuth. For the OAuth flow specifically, see OAuth Implementation Instructions.

How it fits together

  1. Start from the Integration Template.

  2. Implement the SDK interfaces for your system, using the Sample Integration as a reference.

  3. Test locally with the Development Utility.

  4. Compile to a .dll (under 10 MB).

  5. Upload the .dll to an integration version and configure and test it in staging.

Related Articles

Did this answer your question?