SharePoint

Skip Navigation LinksCloud Integration Platform (CIP)

​​​​​​​​​

​​​​​​​​​​​​​​​​​​​​​​​CLOUD INTEGRATION PLATFORM​ (CIP)

AgroIT's key deliverable is the cloud integration platform (CIP), a middle-ware to integrate services of different software solutions. In a first step services of the project's software partners (Datalab, SEGES, PESSL, EFOS, Sinerg​ise, and FreedomGrow) and in a second step as an open platform to publish services of any software solution provider that is interested in doing so. The solution has been developed the project partner University of Ljubljana (UL). ​​​


Development Achievements


Definiti​on of the final modular architecture of AgroIT CIP by integrating key underlying technologies into a scalable centralized platform (Apiman, Keycloak and RabbitMQ).

Designing and implementing an API marketplace, consisting of a catalog of integration services and their APIs (public and private).

Designing and implementing integration services, such as publishing services, managing access, configuring services, endpoint management, service usage, registering to AgroIT CIP, service discovery, service description, and documentation.

Designing and implementing a user and organization management with a central management of users and organizations, registration and approval workflows, account management, security administration, and security mechanisms for data access.

Extensive testing of AgroIT CIP and deploying the platform into a staging environment available at: http://agroit.li.fri.uni-lj.si

 

Preparation for Piloting​

Implementation of a pilot version of integration services with all project partners that include the following functionalities:

​- Service producer perspective: publishing service to AgroIT CIP, managing access to APIs (access level, throttling, SLA), endpoint and resource management, service usage – metering and monitoring, dependencies between services, version control, consumer notifications, publishing API to gateway

​- Service consumer perspective: creating and managing client applications, publishing client application to gateway, registering client application to API
Screen shot 1: Excerpt of the service catalog of the pilot API marketplace

 

Screen shot 2: Publishing a new service on the API marketplace, first step

Actual integration through cloud service platform with all project partners:

User management with the following functionalities (Keycloak): registering and management of users and organizations including roles; administration of security for services (realm management)​

  • - Management of security for published APIs (Keycloak): creating and managing organization security realm; defining and managing API (service) roles; managing subscription flow to APIs (confirmation flow mechanism)

  • - Event-driven and reliable delivery integration pattern (Event Gateway, RabbitMQ): registering event producers and event types; registering event consumers; subscribing applications to events; reliable delivery of requests and responses through messaging queues​​​


 


 


 

 

 

 


 Screen shot 3: Publishing a new service on the API marketplace, last step​

 


Screen shot 4: Monitoring and metering through integration services​


Screen shot 5: Consumer notifications through integration services​

 
 

 
 Screen shot 8: User management / securing API and managing user roles of service​​​
 

Screen shot 6: User management / organization management​                                                                                 Screen shot 9: Registering event API, first step 

 
       
Screen shot 7: User management / managing user information and groups​                                                     Screen shot 10: Registering event API, second step​ 

API Monitoring


-AgroIT CIP allows you to monitor the usage of your APIs. 
For each API AgoIT CIP will gather general usage statistic, 
usage statistic per application and usage statistic per subscription plan.
You can view the usage statistic for the interval of last hour, last day, last week, 
last month and last three months.

-AgroIT CIP also monitorst the response type statistic which tells you the procentage 
of successful API responsens, error API responses and failed API responses. 
Response type statistic provides general statistic and statistic per application.
Finaly you can also monitor API repose times and latency.

 API Monitoring.png 
Screen shot 1: API Monitoring

Explore and Discover APIs


Discover APIs on AgroIT CIP central API catalog. AgroIT CIP enables you to search
APIs in central catalog with full-text search capabilities and filtering based on API categories. 
Chose API in your interest and dive into detailed documentation, explore and test API endpoints, 
check and subscribe to subscription plans presented in API requirements and finally follow 
the API announcements for new API versions.

API Catalog.png            API Documentation.png
Screen shot 2: API Catalog                                                                                                                                                      Screen shot 3: API Documentation

API Endpoints 1.png    API Endpoints 2.png
Screen shot 4: API Endpoints 1                                                                                                                                               Screen shot 5: API Endpoints 2


Explore API Subscription Plans


​Explore API subscription plans and discover access policies to consume the API. 
Register your application and subscribe application the the API using your prefared subscription plan.
 After API owner confirms your subscription request you will receive API-Key that you use to call the API. 
After you subscribe you will receive API announcments about updates and new API versions

API announcements.png     API subscription plans.png

Screen shot 5: API announcements                        

NEW API
Register your organisation on AgroIT CIP and expose your APIs on EU AgroIT API Marketplace. AgroIT CIP will lead you through five stages to describe and document your API:
    1. General API information
    2. API Endopoints
    3. Locations
    4. Subscription Plans
    5. Access policies
    6. Documentation
After you publish, your API will be shown in central API catalog where API consumers will be able to find, discover, subscribe and integrate with your API.
API -General settings.png
   Screen shot 6: API subscription plans




         

 API - Access ploicies.png
                 Screen shot 7: API - Access policies
          
           API - Endpoints.png
                Screen shot 8: API - Endpoints

              API - General Documentation.png
                Screen shot 9: API - General Documentation​