Skip to main content

Extending WSO2 API Manager



WSO2 API Manager consists with two web applications as APIStore and APIPublisher. APIPublisher UI is important to create/publish APIs and APIStore UI is useful to create applications/subscribe to published APIs.

If we think about a use-case of  a company in which adopted the WSO2 APIManager solution; above Store/Publisher apps need to interact with third party users,not only with company internal employees.Such that in real business case,it's really important and useful if below two facts can be achieved through WSO2 API Manager apps.And ofcourse,it has proven that the below facts can be achieved from WSO2 API Manager.
  • Customizing both Store/Publisher apps
Customization is really needed,if the company want to host the two apps with using a customized theme and their logos.This can be easily done by the steps described in here.
  • Host Store/Publisher apps in a public domain own by the company
Host the apps in a public domain is a real world business requirement as above Store/Publisher apps need to interact with third party users.You can achieve this by following below steps.

NOTE: You have to try with API Manager pack from 1.1.0 on wards.Download the pack from here and extract it.
1) Open carbon.xml from the location {APIManager_Home}/repository/conf/ and uncomment below entries   
   , and add the related hostname value to them,

 To set the custom hostname as a part of the End Point References of deployed services in the server.
  <HostName>mydomain </HostName>
To use the custom hostname in Carbon management console
<MgtHostName>mydomain</MgtHostName>

2) Next,to change the displaying endpoints per a API from API-Store view, open api-manager.xml file from  
  /repository/conf/ and update the entry which can be found under configuration section as   
  below.

 <APIEndpointURL>http://mydomain>:${http.nio.port},https://mydomain:${https.nio.port}</ 
   APIEndpointURL>

3) Further if you want to change the apps context roots from default values as /store and /publisher to custom values.As an example,let's assume you want to change 'store' app context root from '/store' to '/apistore';
  • navigate to '{APIManager_Home}/repository/deployment/server/jaggeryapps/store/site/conf' and open the site.json file.Change its defined 'context' value as 'apistore' as follows.
    •          "context" : "/apistore"

  • Additionally change the directory name 'store' to 'apistore' from the location '{APIManager_Home}/repository/deployment/server/jaggeryapps'.That's it.Since jaggery apps hot deployment is enabled by default,try to access "http://yourDomain:port/apistore".



Comments

  1. UnknownMay 21, 2013 at 1:45 PM

    Just in case no one has said it, this was helpful...

    I had figured it was easy enough, just didn't know how easy.

    Thanks!

    ReplyDelete

Post a Comment

Popular posts from this blog

Convert an InputStream to XML

For that we can use DocumentBuilder class in java. By using the method parse(InputStream) ; A new DOM Document object will return. InputStream input; DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); DocumentBuilder parser = factory.newDocumentBuilder(); Document dc= parser.parse(input); In the above code segment,by using the created Document object,the corresponding XML file for the inputStream can be accessed. References: http://www.w3schools.com/dom/dom_intro.asp http:// download.oracle.com/javase/1.4.2/docs/api/javax/xml/parsers/DocumentBuilder.html
2 comments
Read more

Concat two xml values with XSLT

The use-case described in this blog-post,is there's an WSO2 ESB node setup to proxy an incoming message to a particular back-end endpoint.  Before delivering the message to the back-end endpoint,from the ESB node itself,this incoming message need to processed and change its inside xml payload format. For eg: Below is the incoming message <?xml version="1.0" encoding="UTF-8"?> <CinemaHall name="liberty"> <OwnerData> <Name>John Smith</Name> <openedDate>12/12/80</openedDate> <quality>good</quality> </OwnerData> <CinemaHallData> <rows>100</rows> <seats> <seat>50</seat> <seat>60</seat> </seats> </CinemaHallData> </CinemaHall> This message need to be changed as  below; <?xml version="1.0" encoding="UTF-8"?> <CinemaHall name="liberty"...
3 comments
Read more

Passing end-user details from client to real backend endpoint via JWT token

In real-world business system,WSO2 API Manager useful on exposing company APIs, in a secured and controlled manner with the features provided by APIManager as; OAuth support [To secure API invocations] Throttling support [To control API invocations] Monitoring support [To track API usage] More technically what happening is when a user sends a particular API request,it will goes to WSO2 APIManager node and from there,the request will route to the real implemented back-end endpoint of the particular API and get back the response and returned it to the API invoked user. There can be a use-case,that this back-end endpoint may expect the details of API invoked user as to pass those details to some internal company usage  as; Additional authentication/authorization Track usage data from an internal system. So how to support above requirement from WSO2 AM. There comes the use of JSON Web Token[JWT] implementation done inside WSO2 AM. JWT is a means of representing claims to...
7 comments
Read more