Skip to content

Commit f729576

Browse files
authored
Update README.md
1 parent 381070c commit f729576

File tree

1 file changed

+48
-41
lines changed

1 file changed

+48
-41
lines changed

README.md

Lines changed: 48 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,87 @@
1-
# ECGrid API Overview
2-
Loren Data ECGridOS API Version 3.2-4.X Documentation.
1+
# Getting Started with ECGridOS™ API
32

4-
Loren Data Launch API Updates for version 4.x - Find out about the latest enhancements here: [https://ecgrid.freshdesk.com/support/solutions/articles/6000247116-ecgrid-api-updates-4-x](https://ecgrid.freshdesk.com/support/solutions/articles/6000247116-ecgrid-api-updates-4-x)
3+
[**Getting Started - Basics**](https://support.ecgrid.com/en/support/solutions/articles/6000271712-ecgridos-api-getting-started)
4+
<br>[**Getting Started - Extended Capabilities**](https://support.ecgrid.com/en/support/solutions/articles/6000271768-ecgridos-api-getting-started-extended-capabilities)
55

6-
The Latest Version of the API is 4.1
76

8-
The Minimum Supported Version is 3.2
7+
# Introduction to ECGridOS™
98

10-
_Take control of EDI and B2B Document exchange with our library of APIs._
9+
The ECGridOS platform was developed by Loren Data Corp., an established provider of supply chain messaging infrastructure and services since 1996. ECGridOS™ is an Operating System as a Service (OSaaS), that manages the ECGrid® Supply Chain Integration Network, transporting transactions, messages, and reports between businesses around the world. ECGridOS hosts a robust set of discrete platform processes such as Web Service APIs, enabling developers to integrate supply chain communications capabilities into mission-critical applications, systems, and workflows.
1110

12-
ECGrid's API's allow companies, service providers, solutions integrators and ISV's to extend their B2B capabilities using modern skills and cloud native tools.
11+
ECGridOS is specifically designed for quick, secure, and accurate electronic business documents exchange, such as purchase orders, invoices, and shipping notices, between hundreds of thousands of trading partners around the globe. ECGrid supports all file formats including legacy Electronic Data Interchange (EDI) standards such as X12 and EDIFACT as well as all modern formats including XML, JSON and all user-defined data formats.
1312

14-
Loren Data Corp’s ECGrid is the industry’s only API extendable platform for all EDI and B2B document exchange. ECGrid was built to support high volume communications with rich tools for exception management and visbility to optmize your operations. ECGrid and the open API framework was conceived and refined to deliver customized EDI and B2B communications and trading partner management for the largest service providers and B2B SaaS application ventures.
13+
Cloud applications frequently publish sets of web service APIs to extend access into system data, allowing users and developers basic functions to integrate externally. ECGridOS takes web services to the next level as a 100% API-based web service-based operating system. ECGridOS delivers all the capabilities required to internally operate and externally integrate a global supply chain communications network.
1514

16-
ECGrid's web services APIs support over 210 functions for direct access to account creation, user ID and mailbox management, user sessions, network management (interconnections to other ID’s on Value Added Networks), real time message status, and much more.
15+
ECGridOS publishes an extensive library of APIs which delivers full command, control, and communication functionality over operations, integrations, and implementations. Like a traditional operating system, ECGridOS is a foundational application with over 200 fine grain API’s, covering all aspects of EDI network configuration and communications. ECGridOS delivers all core ECGrid internal processes and provides the platform for all external communication channels and user portal access. External developers will find the complete set of tools to support the full-lifecycle of an organization’s implementation – Onboarding, Management and Offboarding. ECGridOS provides a set of essential services and functions that enable the effective and efficient use of the ECGrid network directly from enterprise applications, such as an ERP or WMS system, or integration into cloud platforms that support supply chain data exchange.
1716

18-
Our Services Portfolio is designed specifically for B2B platforms that manage thousands of end user mailboxes and millions of files/EDI transactions. The API capabilities of ECGrid allows our customers and partners to integrate directly into their business systems and the shared processes in their supply chain or other strategic business processes.
17+
Strategically, ECGridOS is about increased control and flexibility using “fine grain” (SOAP) APIs for a more interactive programming model than found in “coarse grain” (REST) API integration projects. The ECGrid approach puts partners, customers, and SaaS platform teams in full control of their implementation.
1918

20-
# ECGrid
19+
2120

22-
A secure B2B Value-Added network with an independent node architecture. ECGrid nodes are scaleable, flexible, and very reliable. ECGrid is the right choice for high-traffic cloud applications and enterprise software & services companies – an ideal platform for service providers, integration consultants, and VARs.
21+
# Benefits of a Fine-Grain API Approach
2322

24-
Version 3.2 API URL: [https://ecgridos.net/v3.2/prod/ECGridOS.asmx](https://ecgridos.net/v3.2/prod/ECGridOS.asmx)
23+
A fine-grain API approach, where the API exposes a larger number of methods or functions that perform smaller, more specific tasks, can offer several benefits depending on the context and requirements of a particular software development project. Some advantages of using a fine-grain API include:
2524

26-
Version 4.1 API URL: [https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx](https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx)
25+
1. **Granular Control:** Fine-Tuned Operations: Developers have more control over individual components or operations. This level of granularity allows them to fine-tune interactions with the system, performing specific actions as needed.
2726

27+
2. **Flexibility and Customization:** Tailored Solutions: Fine-grain APIs enable developers and ISVs to create more customized and tailored solutions for their customers using ECGridOS. They can choose specific methods relevant to their use case and build solutions with precisely the desired functionality.
2828

29-
_Check the [_Wiki Page_](https://github.com/LorenData/ECGridOS_API/wiki) for our API documentation._
29+
3. **Efficiency in Resource Utilization:** Developers can optimize resource usage by invoking only the necessary fine-grain operations. This can lead to more efficient utilization of system resources, such as network bandwidth, memory, and processing power.
3030

31-
[ECGridOS User's Guide](https://github.com/LorenData/ECGridOS_API/wiki/ECGridOS-User's-Guide)
31+
4. **Scalability:** Developers can scale different components independently, making it easier to adapt to changing requirements and handle increased loads in specific areas of the application.
3232

33-
[Getting Started with ECGridOS and Visual Studio](https://github.com/LorenData/ECGridOS_API/wiki/Getting-Started-with-ECGridOS-and-Visual-Studio)
33+
5. **Modularity:** Fine-grain APIs promote a modular development approach. Each fine-grain method can represent a module or a specific feature, making it easier to develop, test, and maintain modular code.
3434

35-
[ECGridOS API Calls](https://github.com/LorenData/ECGridOS_API/wiki/ECGridOS-API-Calls)
35+
6. **Enhanced Debugging and Testing:** Fine-grain APIs allow for more granular testing of individual components, making it easier to identify and address issues. Debugging can be more focused on specific functionalities, simplifying the troubleshooting process.
3636

37-
[Appendix](https://github.com/LorenData/ECGridOS_API/wiki/Appendix)
37+
7. **Diverse Use Cases:** ECGrid’s fine-grain APIs support diverse use cases. Developers can leverage the flexibility of the API to address a wide range of requirements without being constrained by a predefined set of higher-level coarse-grain APIs.
3838

39-
[Legacy Forum Q & A](https://github.com/LorenData/ECGridOS_API/wiki/Legacy-Forum-Q-&-A)
39+
With ECGridOS you can start with a single use case and extend to more advanced capabilities over time. Engineers and ISVs are not limited in their options while automating their B2B data exchange.
4040

41+
Key Capabilities supported by the ECGridOS library to facilitate your B2B data exchange requirements include:
4142

42-
# Example Projects
43+
1. **Account provisioning:** ECGridOS allows for full control of account provisioning and management via APIs right from your organization’s infrastructure and systems consistent with your organizational controls and workflows.
4344

44-
SOAP ECGridOS API v4.1 .NET Framework 4.8 Console App
45+
- **User/Customer Onboarding:**
4546

46-
- Example for .Net Framework 4.8 using a Web Reference.
47+
- _Account and Mailbox Creation:_ When a new employee joins an organization, account provisioning involves creating user accounts for them in relevant systems. This includes assigning a unique username, password, and any necessary identification details with role-based access controls.
4748

48-
SOAP ECGridOS API v4.1 .NET 6 Console App
49+
- _Role-Based Access:_ Account provisioning often aligns with role-based access principles to ensure users have access only to the resources necessary for their job roles and implementation requirements.
4950

50-
- Example for .Net 6 Console App using a SOAP ServiceModel.
51+
- **Access Permissions:** Based on the user's role and responsibilities, account provisioning establishes the appropriate access permissions to IT resources. This may include access to email, file repositories, applications, and other services.
5152

52-
HTTP ECGridOS API v4.1 .NET 6 Console App
53+
- **Updates to User Attributes:** Changes to user attributes, such as contact information or job title, may also be part of the account provisioning process to keep user records accurate.
5354

54-
- Example for .Net 6 Console App using HTTPClient.
55+
- **User/Customer Offboarding:** When an employee leaves the organization or changes roles, account provisioning includes deactivating or disabling their account to prevent unauthorized access. This is a critical step in maintaining security and compliance.
5556

56-
HTTP ECGridOS API v4.1 .NET 6 Console App WebClient
57+
2. **Connectivity:** Use the APIs to create and manage communications to and from your network and external environments (trading partner, service provider, VAN, etc.). ECGridOS allows you to connect to your partners regardless of protocol or the network they use.
5758

58-
- Example for .Net 6 Console App using deprecated WebClient.
59+
3. **Transaction Management and Data Exchange:** The platform allows users to send and receive data directly from their trading partners and to track the status of EDI transactions/files, providing visibility into the status of messages as they move through the communication process.
5960

60-
HTTP ECGridOS API v4.1 .NET 6 Console App ServiceCollections
61+
4. **Message Routing:** ECGridOS helps in routing EDI messages between trading partners, ensuring that the right information reaches the intended recipient. The platform also provides rich content support and content routing by supporting various EDI standards and protocols, ensuring compatibility with different trading partners and industry requirements. ECGridOS also allows the configuration of managed file transfer (MFT) for non-standards-based data.
6162

62-
- Example for .Net 6 Console App using ServiceCollections and Dependency Injection.
63+
5. **Trading Partner Management:** ECGridOS facilitates the management of trading partner relationships, including the onboarding of new partners and the configuration of EDI communication settings.
6364

64-
HTTP ECGridOS API v4.1 .NET 6 ASPNET Core WebApp
65-
66-
- Example for .Net 6 ASP.NET WebApp using Razor Pages.
65+
6. **Alerts and Notifications:** Users can set up alerts and notifications to be informed of important events, such as the receipt of new messages or the status changes of transactions.
6766

68-
HTTP ECGridOS API v4.1 .NET 6 ASPNET Core MVC
67+
7. **Error Handling/Management:** The OS monitors the system for errors and faults, providing error handling mechanisms to prevent catastrophic failures. It may also log errors and generate reports for diagnostics and troubleshooting.
6968

70-
- Example for .Net 6 ASP.NET WebApp using MVC Framework.
69+
8. **Security:** Secure data exchange is essential in EDI and ECGridOS includes mechanisms for secure data transmission, authentication, and authorization to protect sensitive business information.
7170

72-
HTTP ECGridOS API v4.1 .NET 6 Worker Service
7371

74-
- Example for .Net 6 Worker Service.
75-
7672

77-
# Unified AS2 via ECGrid APIs
73+
# Quick Reference Notes
7874

79-
Programmable AS2 support for building a community of trading partners. This is AS2 built for operators at scale and large enterprises deploying secure communications or require compliance to trading partner requirements. This hosted offering provide global connectivity, archiving and visibility support through the EGrid API library.
75+
_ECGridOS Versioning:_ The latest version of the ECGridOS API is 4.1.
8076

77+
_API URL:_ https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx
78+
79+
_ECGridOS Web Services:_ Given the confidential nature of electronic commerce, ECGridOS can only be accessed securely over HTTPS.
80+
81+
_ECGridOS Support:_ ECGrid Support can be reached at support@ecgrid.com.
82+
83+
[ECGridOS API Call Library](https://github.com/LorenData/ECGrid-API/wiki/API-Calls)
84+
85+
[API Wiki Page](https://github.com/LorenData/ECGrid-API/wiki)
86+
87+
[Full ECGridOS User's Guide](https://github.com/LorenData/ECGrid-API/wiki/ECGridOS-User's-Guide)

0 commit comments

Comments
 (0)