...
- To issue only sandbox keys when creating production keys is deferred until testing is complete.
- To restrict untrusted applications from creating production keys. You allow only the creation of sandbox keys.
- To make API subscribers go through an approval process before creating any type of access token.
Configuring the Business Process Server
Download WSO2 Business Process Server.
Set an offset of 2 to the default BPS port in
<BPS_HOME>/repository/conf/carbon.xml
file. This prevents port conflicts that occur when you start more than one WSO2 product on the same server. Also see Changing the Default Ports with Offset.Code Block language xml <Offset>2</Offset>
Note If you change the port offset to some a value other value than 2 or run the API Manager and BPS on different machines (therefore, want to set the
hostname
to a different value thanlocalhost
), you must do the following:- Search and replace the value 9765 in all the files (.epr, .wsd wsdl files inside the ZIP archives) inside
<APIM_HOME>/business-processes
folder with the new port. - Zip the files you unzipped earlier and deploy the newly created zip file in BPS as explained in the steps below.
- Search and replace port 9445 in
<AM_HOME>/repository/deployment/server/jaggeryapps/admin-dashboard/site/conf/site.json
file.
- Search and replace the value 9765 in all the files (.epr, .wsd wsdl files inside the ZIP archives) inside
Copy the following from
<APIM_HOME>/business-processes/epr
to<BPS_HOME>/repository/conf/epr
folder. If the<BPS_HOME>/repository/conf/epr
folder isn't there, please create it.
-
RegistrationService.epr
-
RegistrationCallbackService.epr
-
Start the BPS server and log in to its management console (
https://<Server Host>:9443+<port offset>/carbon
).- Select Add under Processes menu and upload t he
<APIM_HOME>/business-processes/application-registration/BPEL/A
pplicationRegistrationWorkflowProcessApp
licationRegistrationWorkflowProcess_1.0.0.zip
file to BPS. This is the business process archive file.
- Similarly, upload Select Add under the Human Tasks menu and upload
<APIM_HOME>/business-processes/application-registration/HumanTaskBPEL/ApplicationRegistrationTaskApplicationRegistrationTask-1.0.0.zip
to BPS. This is the human task archived file.
...
- Log in to APIM management console (
https://<Server Host>:9443/carbon
) and select Browse under Resources .
Go to
/_system/governance/apimgt/applicationdata/workflow-extensions.xml
resource, disable the Simple Workflow Executor and enable WS Workflow Executor:Code Block language html/xml <WorkFlowExtensions> <!--ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/--> <ProductionApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor"> <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property> <Property name="username">admin</Property> <Property name="password">admin</Property> <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property> </ProductionApplicationRegistration> <!--SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationSimpleWorkflowExecutor"/--> <SandboxApplicationRegistration executor="org.wso2.carbon.apimgt.impl.workflow.ApplicationRegistrationWSWorkflowExecutor"> <Property name="serviceEndpoint">http://localhost:9765/services/ApplicationRegistrationWorkFlowProcess/</Property> <Property name="username">admin</Property> <Property name="password">admin</Property> <Property name="callbackURL">https://localhost:8248/services/WorkflowCallbackService</Property> </SandboxApplicationRegistration> </WorkFlowExtensions>
Note Note that all workflow process services of the BPS run on port 9765 as you changed its default port with an offset of 2.
Go to the API Store Web interface, open My Subscriptions page, select an application and click the Generate button associated with the production key.
It invokes theApplicationRegistrationWorkFlowProcess.bpel
that is bundled withApplicationRegistrationWorkflowProcess_1.0.0.zip
and creates a HumanTask instance that holds the execution of the BPEL process until some action is performed on it.Note a message that appears saying that the request is successfully submitted if the BPEL was invoked correctly. For example,
Log in to the workflow-admin app Admin Dashboard Web application (
https://localhost<Server Host>:9443/workflowadmin-admindashboard
) and list all the tasks for application registrations. Click Start to start the Human Task and then change its state.
Once you approve the task, it resumes the BPEL process and completes the registration.Go Go back to the My Subscriptions page on the API Store and view your application.
It shows the application access token, consumer key and consumer secret. For example,
After the registration request is approved, keys are generated by invoking theAPIKeyMgtSubscriber
service hosted in Key Manger nodes. Even when the request is approved, key generation can fail if this service becomes unavailable. To address such failures, you can configure to trigger key generation at a time Key Manager nodes become available again.
Given below is the the message used to invoke the BPEL process:Code Block language html/xml <applicationregistrationworkflowprocessrequest xmlns:wor="http://workflow.application.apimgt.carbon.wso2.org" xmlns="http://workflow.application.apimgt.carbon.wso2.org"> <applicationname>NewApp5</applicationname> <applicationtier>Unlimited</applicationtier> <applicationcallbackurl></applicationcallbackurl> <applicationdescription></applicationdescription> <tenantdomain>carbon.super</tenantdomain> <username>admin</username> <workflowexternalref>4a20749b-a10d-4fa5-819b-4fae5f57ffaf</workflowexternalref> <callbackurl>https://localhost:8243/services/WorkflowCallbackService</callbackurl> <keytype>PRODUCTION</keytype> </applicationregistrationworkflowprocessrequest>