An overview of the Management API. The API provides management capabilities for Clouds and Integration Appliances.
The Management API is implemented as a web service. This web service provides a way to manage App Connect Appliances (Integration Appliances) and App Connect on Cloud (Cloud) projects through your applications or scripts.
The API provides Integration Appliance and Cloud management in the following areas:
The Management API complies with the following web services standards:
You can create client applications that call web services operations to manage and monitor Integration Appliances and Cloud projects. Communication between the client application and the Integration Appliance orCloud project is accomplished by using HTTP or HTTPS.
The Management API is defined in WSDL files. Client applications call web services operations by sending SOAP messages. SOAP messages are formatted in XML and so are programming language neutral.
This section provides examples of logging in, getting a user and logging out using the Management API - Security WSDL.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
<soapenv:Header/>
<soapenv:Body>
<sec:login>
<sec:username>webuser@mycompany.com</sec:username>
<sec:password>D3nu9noB</sec:password>
</sec:login>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:loginResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
security" xmlns:ns3="http://www.approuter.com/schema/router/1000/security/03">
<ns2:sessionId>8F059BEEA3611033D277773A95404641</ns2:sessionId>
</ns2:loginResponse>
</S:Body>
</S:Envelope>
The sessionId is required
to perform other SOAP operations after you log in to an Integration Appliance or the Cloud.<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
<soapenv:Header>
<sec:sessionId>8F059BEEA3611033D277773A95404641</sec:sessionId>
</soapenv:Header>
<soapenv:Body>
<sec:getUser>
<sec:username>webuser</sec:username>
</sec:getUser>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getUserResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
security" xmlns:ns3="http://www.approuter.com/schema/router/1000/security/03">
<ns2:user>
<ns3:id>8F059BEEA3611033D277773A95404641</ns3:id>
<ns3:name>webuser</ns3:name>
<ns3:encPasswd>{SHA}clO20r2ZJMJcDrNwXQzhWB8YcdI=</ns3:encPasswd>
<ns3:displayName>WebServiceUser</ns3:displayName>
<ns3:isActive>true</ns3:isActive>
<ns3:isMutable>true</ns3:isMutable>
<ns3:isVisible>true</ns3:isVisible>
<ns3:email>webuser@mycompany.com</ns3:email>
<ns3:createdTime>2010-03-02T22:11:32.935Z</ns3:createdTime>
<ns3:failedLoginCount>0</ns3:failedLoginCount>
<ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
<ns3:scopeType>Tenant</ns3:scopeType>
</ns2:user>
</ns2:getUserResponse>
</S:Body>
</S:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
<soapenv:Header>
<sec:sessionId>8F059BEEA3611033D277773A95404641</sec:sessionId>
</soapenv:Header>
<soapenv:Body>
<sec:logout/>
</soapenv:Body>
</soapenv:Envelope>
The previous examples used SOAP operations that ran in a tenant in the Cloud or an Integration Appliance. To run operations in environments within a tenant in the Cloud, you use the setCurrentScope operation to set the scope to the environment where you want to run SOAP operations.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
<soapenv:Header>
<sec:sessionId>63Y93HD6D856EB5812EB71216C3547W7</sec:sessionId>
</soapenv:Header>
<soapenv:Body>
<sec:setCurrentScope>
<sec:scopeName>Development</sec:scopeName>
</sec:setCurrentScope>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:setCurrentScopeResponse xmlns:ns2="http://www.approuter.com/
schemas/2008/1/security" xmlns:ns3="http://www.approuter.com/schema/
router/1000/security/03">
<ns2:success>true</ns2:success>
</ns2:setCurrentScopeResponse>
</S:Body>
</S:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:dep="http://www.approuter.com/schemas/2008/1/deployment">
<soapenv:Header>
<dep:sessionId>63Y93HD6D856EB5812EB71216C3547W7</dep:sessionId>
</soapenv:Header>
<soapenv:Body>
<dep:start>
<dep:projectName>HTTP_363i</dep:projectName>
<dep:version>1.0</dep:version>
<dep:configName>HTTP_363j</dep:configName>
</dep:start>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:startResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
deployment" xmlns:ns3="http://www.approuter.com/schemas/2008/1/deployment/
types" xmlns:ns4="http://www.approuter.com/schema/router/1000/security/03"
xmlns:ns5="http://www.approuter.com/schemas/2008/1/util/types">
<ns2:success>true</ns2:success>
</ns2:startResponse>
</S:Body>
</S:Envelope>