This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Page Comparison - Adding an API Subscription Workflow (v.4 vs v.9) - API Manager 1.10.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: https://wso2.org/jira/browse/DOCUMENTATION-4299

...

Tip

Before you begin, if you have changed the API Manager's default user and role, make sure you do the following changes:

  • Give the correct credentials in the <BPS_HOME>/repository/conf/epr files.
  • Change the credentials of the workflow configurations in the registry resource _system/governance/apimgt/applicationdata/workflow-extensions.xml.
  • Point the database that has the API Manager user permissions to BPS.
  • Share any LDAPs, if exist.
  • Change the user credentials in <APIM_HOME>/repository/conf/api_manager.xml file.
  • Change the .ht file of the relevant human task.
  • Unzip the <APIM>/business-processes/subscription-creation/HumanTask/SubscriptionsApprovalTask-1.0.0.zip file, update the role as follows in the SubscriptionsApprovalTask.ht file, and ZIP the SubscriptionsApprovalTask-1.0.0 folder.

    Code Block
    titleFormat
    <htd:argument name="role">
    	[new-role-name]
    </htd:argument>
  • Change the allowedRoles parameter in the <APIM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/site/conf/site.json file.

...

Open the <APIM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/site/conf/site.json file and configure "workFlowServerURL" under "workflows" to point to the BPS server (e.g. "workFlowServerURL": "https://localhost:9445/services/")

...

  1. Log in to APIM admin console (https://<Server Host>:9443/carbon) and select Browse under Resources.

  2. Go to /_system/governance/apimgt/applicationdata/workflow-extensions.xml resource, disable the Simple Workflow Executor and enable WS Workflow Executor. Also specify the service endpoint where the workflow engine is hosted and the credentials required to access the said service via basic authentication (i.e., username/password based authentication).  

    Code Block
    languagehtml/xml
    <WorkFlowExtensions>
     
    ...
        <SubscriptionCreation executor="org.wso2.carbon.apimgt.impl.workflow.SubscriptionCreationWSWorkflowExecutor">
             <Property name="serviceEndpoint">http://localhost:9765/services/SubscriptionApprovalWorkFlowProcess/</Property>
             <Property name="username">admin</Property>
             <Property name="password">admin</Property>
             <Property name="callbackURL">https://localhost:8243/services/WorkflowCallbackService</Property>
        </SubscriptionCreation>
    ...
    
    </WorkFlowExtensions>
    Tip

    Note  that all workflow process services of the BPS run on port 9765 because you changed its default port (9763) with an offset of 2.

    The application creation WS Workflow Executor is now engaged.

  3. Go to the API Store Web interface and subscribe to an API.
    It invokes the API subscription process and creates a Human Task instance that holds the execution of the BPEL until some action is performed on it.

  4. Note the message that appears if the BPEL is invoked correctly, saying that the request is successfully submitted. 

  5. Log in to the Admin Dashboard Web application ( https://<Server Host>:9443/admin-dashboard ), list all the tasks for API subscription and approve the task. It resumes the BPEL process and completes the API subscription.

  6. Go back to the API Store and see that the user is now subscribed to the API.

    Whenever a user tries to subscribe to an API, a request of the following format is sent to the workflow endpoint:

    Code Block
    languagehtml/xml
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:wor="http://workflow.subscription.apimgt.carbon.wso2.org">
       <soapenv:Header/>
       <soapenv:Body>
          <wor:createSubscription>
             <wor:apiName>sampleAPI</wor:apiName>
             <wor:apiVersion>1.0.0</wor:apiVersion>
             <wor:apiContext>/sample</wor:apiContext>
             <wor:apiProvider>admin</wor:apiProvider>
             <wor:subscriber>subscriber1</wor:subscriber>
             <wor:applicationName>application1</wor:applicationName>
             <wor:tierName>gold</wor:tierName>
             <wor:workflowExternalRef></wor:workflowExternalRef>
             <wor:callBackURL>?</wor:callBackURL>
          </wor:createSubscription>
       </soapenv:Body>
    </soapenv:Envelope>

     Elements of the above configuration are described below:

    ElementDescription
    apiName
    Name of the API to which subscription is requested.
    apiVersion
    Version of the API the user subscribes to.
    apiContext
    Context in which the requested API is to be accessed.
    apiProvider
    Provider of the API.
    subscriber
    Name of the user requesting subscription.
    applicationName
    Name of the application through which the user subscribes to the API.
    tierName
    Throttling tiers specified for the application.
    workflowExternalRefThe unique reference against which a workflow is tracked. This needs to be sent back from the workflow engine to the API Manager at the time of workflow completion.
    callBackURL

    The URL to which the Workflow completion request is sent to by the workflow engine, at the time of workflow completion. This property is configured under the callBackURL property in the api-manager.xml file.