API
Working with the iPaaS.com API
14 articles
- API IntroductionLearn how to use the iPaaS.com API
- The iPaaS.com REST API: Swagger/OpenAPI Reference GuideYour starting point for the iPaaS.com REST API: every service, its Swagger documentation, authentication, and request essentials.
- Whitelisting iPaaS.com IP AddressesThe outbound IP addresses iPaaS.com uses to call external system APIs, for firewall and API allowlist configuration.
- Accessing the APILogging into the API, Authenticating and Switching Companies
- Using the Transaction API to Post Transactions and Transaction TrackingCreating Transactions and Transaction Tracking via the API
- External IDs ReferenceHow iPaaS maps internal record IDs to external system IDs via the external_ids array, including request and response shapes, plus the dedicated External ID endpoints.
- Custom Fields ReferenceUser-defined metadata on iPaaS records via the custom_fields array, including nested vs. standalone request shapes, response shape, and how definitions and values are managed.
Examples
Examples using the API
- Working with API Rate LimitsHow to handle API rate limits with automatic retry logic and error handling
- Handling Composite Primary Keys in a Data ModelUnified ID management for objects identifiable by single or composite keys
- Flattening Complex API Response Objects for Simplified Mapping (NetSuite Example)Transform nested API objects into simple fields for easier user mapping
- Preserving State on Partial Success with Custom ExceptionsCapture partial success data in custom exceptions for smarter error handling
- Simplifying End-User Data Mapping for Nested API Requests (Acumatica Example)Abstract nested JSON complexity for simplified end-user data mapping
- Filtering Logically Deleted Records from API ResponsesPost-processing filter ensures APIs return only active records, hiding soft deletes from clients
- Implementing Soft Deletes with Extension Fields in API IntegrationsImplement soft deletes using API extension fields to preserve data while hiding deleted records