PRISM-API Gateway
Connect partners and applications that work through APIs
Some trading partners, marketplaces and applications offer or expect APIs instead of EDI documents. PRISM-API Gateway is ECOM's product for API integration and connectivity, so those partners join the same integration flows as your EDI partners, and API and EDI connections can serve the same business processes.
What is an API gateway?
An API gateway is the entry point that sits in front of your application programming interfaces. It authenticates callers, enforces access policies and rate limits, routes requests to the right back-end service, and records usage and errors. In B2B integration, an API gateway lets partners exchange data in real time without direct access to internal systems.
Why it matters
Business benefits
Partners that prefer APIs
Connect partners, marketplaces and applications that offer or expect APIs, without asking them to implement EDI.
EDI and APIs in the same process
API and EDI connections can feed the same business processes on the PRISM platform, so business logic is not duplicated.
One integration partner
ECOM designs, builds and supports API and EDI connections together, so there is one accountable team.
Who it's for
Who uses PRISM-API Gateway
Companies whose partners offer APIs
Carriers, marketplaces and some retailers and suppliers offer APIs for orders, status or inventory, and expect partners to use them.
Integration teams connecting applications
Enterprise and SaaS applications that are integrated through APIs rather than EDI documents.
Organizations running EDI and APIs side by side
Teams that want API and EDI partners to follow the same business processes and rules.
Capabilities
What PRISM-API Gateway does
-
API publishing
Expose REST APIs backed by ERP, warehouse or PRISM data, with versioning and documentation.
-
Authentication and access control
Support API keys and OAuth 2.0 patterns, with per-partner access policies.
-
Rate limiting and quotas
Protect back-end systems by controlling request volumes per partner.
-
Transformation
Convert between JSON, XML and EDI so API calls can drive the same processes as EDI documents.
-
Monitoring and analytics
Track calls, latency and errors by partner and API, with alerts through PRISM.
Systems integration
What PRISM-API Gateway connects
Specific API capabilities are confirmed for each use case during scoping.
| System | What flows | What to plan for |
|---|---|---|
| Trading partner APIs | Orders, status and other transactions offered or expected through APIs. | Partners differ in API style and security requirements. |
| Enterprise and SaaS applications | Application data exchanged through APIs. | Through the PRISM platform, alongside EDI and file-based flows. |
Implementation
What an API integration project involves
-
Understand each partner's API
Review the partner's API documentation, authentication method, data model and limits before designing the integration.
-
Map to your business process
Decide which business process each API call feeds, and whether the same process also receives EDI documents.
-
Test with the partner
Test against the partner's sandbox where one exists, including error handling and retries.
-
Monitor in production
Agree how failed calls and exceptions are seen and handled once live.
Use cases
Where teams use it
Order status for key customers
Let strategic customers query order and shipment status directly instead of calling customer service.
Supplier inventory feeds
Receive inventory and availability updates from suppliers in near real time.
EDI-to-API bridging
Accept API orders from new partners and process them through existing EDI-based workflows.
Technology, expertise and operations
Choose how PRISM-API Gateway is run
PRISM is ECOM's own integration technology. The company that builds it also implements, operates and supports enterprise integration platforms, so you can choose how much of the work you keep.
-
Run it with your team
Use PRISM-API Gateway on the PRISM platform with your own staff, supported by ECOM.
Platform delivery options -
Share the work
ECOM integration specialists extend your team for mapping, onboarding, monitoring and changes.
EDI Team as a Service -
Hand it over
ECOM operates the integration end to end as a fully managed service, within an agreed scope.
Fully managed EDI
Running IBM Sterling or another integration platform today? ECOM's enterprise integration specialists can help you keep, modernize or migrate it. IBM Sterling services · Migration and modernization
Available delivery options depend on the product and your requirements and are confirmed during scoping. Compare delivery models.
Implementation
How implementing PRISM-API Gateway works
Every project follows the same five stages. What changes is who does each task, which depends on the delivery model you choose.
-
Discover and scope
- ECOM
- Reviews your trading partners' requirements, documents, systems and volumes, and confirms the scope in writing.
- Your team
- Share partner guides or vendor manuals, sample documents, your ERP and version, and your deadlines.
-
Design and build
- ECOM
- Designs the flows and builds the maps, rules and connections, or supports your team building them on the platform.
- Your team
- Confirm business rules and field meanings, and provide test data and access to the right people.
-
Test and certify
- ECOM
- Tests each document internally, then completes the partner's testing or certification steps.
- Your team
- Check test results in your own systems and approve them before go-live.
-
Transition and go-live
- ECOM
- Plans the cutover, including a move from a current provider or platform, and watches the first live transactions.
- Your team
- Approve the go-live date and coordinate your internal teams and partner dates.
-
Support and improve
- ECOM
- Monitors and supports the integration as your delivery model and service agreement define, and handles partner changes in scope.
- Your team
- Tell ECOM about business changes, new partners and priorities.
What affects timing and price
ECOM sends a scoped proposal after reviewing your requirements. These factors make the most difference:
- How many trading partners and document types are in scope
- Each partner's testing and certification process and schedule
- Your ERP or application, and whether a standard connector fits or custom integration is needed
- Custom business rules, data quality and the work needed to map them
- Connection methods (AS2, SFTP, VAN, API) and security requirements
- Delivery model and support coverage, for example 24×7
- Transaction volumes and any migration from an existing platform
Frequently asked questions
Do we still need EDI if we have APIs?
Usually yes. Many large retailers, manufacturers and carriers continue to require EDI, while others prefer APIs. PRISM lets you support both without duplicating business logic.
Can PRISM convert an API call into an EDI document?
Yes. Data received through an API can be transformed into EDI and processed by the same workflows, and the reverse is also possible.
How are partner APIs secured?
Security requirements, such as authentication and encryption in transit, are agreed with each partner and your security team during design. Specific gateway features are confirmed for your use case during scoping.
What is the difference between PRISM-API Gateway and PRISM-EDI?
PRISM-EDI exchanges standard EDI documents system to system. PRISM-API Gateway provides API-based connectivity. Many organizations use both, so each partner connects in the way it supports.
ECOM products
Integration, visibility, automation and business applications
PRISM is ECOM's own integration and automation platform. PRISM-EDI is the core; the other products extend it to visibility, partner and document automation, APIs and commerce channels. ECOM's business applications, PRISM-ERP, Inventory on Cloud, PRISM Reconcile360 and PRISM MultiChannel Order Management, run core operations alongside it.
- Integration platform PRISM-EDI Our core EDI/B2B integration platform. Explore
- Visibility and optimization PRISM-SCV Visibility into document status, transaction activity, and exceptions across trading partners. Explore
- Partner and document automation PRISM-WebEDI Web-based EDI collaboration and document processing. Explore
- Partner and document automation PRISM-SmartConvert Converting business documents into structured integration data. Explore
- Partner and document automation PRISM-WebConnect Automation of trading partner portals and workflows.
- APIs and commerce channels PRISM-API GatewayYou are here API integration and connectivity.
- Visibility and optimization PRISM-DriveSync Routing and delivery optimization.
- APIs and commerce channels PRISM UniChannel Omnichannel order and fulfillment integration. Explore
- Business applications PRISM-ERP Full ERP solution with modules supporting business operations across multiple industries. Explore
- Business applications Inventory on Cloud Item configuration and inventory management across sales channels. Explore
- Business applications PRISM Reconcile360 Automated cash application and 3-way financial reconciliation. Explore
- Business applications PRISM MultiChannel Order Management One platform for the complete order lifecycle across B2B and B2C sales channels, from order capture to returns and reconciliation. Explore
Connect a partner or application through APIs
Share the partner's or application's API documentation and the business process it should feed. We will outline the integration.