Log in to the management console (
https://hostname:9443/carbon) using admin/admin credentials.
- Select the Users and Roles menu under the Configure menu.
- Click Add New Role and provide
creatoras the role name.
- Click Next.
- Select the following permissions from the list that opens and click Finish.
- Manage > API > Create
- Manage > Resources > Govern and all underlying permissions
Similarly, create the
publisherrole with the following permissions.
- Manage > API > Publish
- You can now create users for each of those roles. To do so, click the Users and Roles menu under the Configure menu.
- Click Users.
- Click Add New User, provide the username/password and click Next.
Select the role you want to assign to the user (e.g.,
subscriber) and click Finish. Given below is a list of usernames and the roles we assign to them in this guide.
Username Role apicreator creator apipublisher publisher
Repeat the steps to create at least one user for all roles.
An API creator uses the API provider Web application to create and publish APIs into the API Store. In this section, we explain how to create an API and attach documentation to it.
Let's create this API and add it to the API Store.
Creating an API
- Open the API Publisher (
https://<YourHostName>:9443/publisher) and log in as
Click the Add link and provide the mandatory information, as described in the table below, to your API.
Field Value Description NamePhoneVerificationName of API as you want it to appear in the APIstoreContext/phoneverifyURI context path that is used by to API consumers Version 1.0.0 API version (in the form of version.major.minor) Tier Availability Bronze/Gold/Silver/Unlimited The API can be available at different level of service; you can select multiple entries from the list. At subscription time, the consumer chooses which tier they are interested in. Transports Select HTTP/HTTPSEndpoint Security SchemeNon-Secured/SecuredIf the back-end service is a secured service, select 'Secured' and enter the credentials for secured service in appearing text boxes. Else keep as Non-Secured. Endpoint Type SelectEndpoint Type. E.g., High available and load balanced endpoints Production Endpoint URLEndpoint of the back-end service URL, here: Sandbox Endpoint URLEndpoint of sandbox (testing) back end service. A sandbox URL is meant to be used for online testing of an API with easy access to an API key. WSDL URLURL of WSDL file (describing API interface) http://ws.cdyne.com/phoneverify/phoneverify.asmx?wsdl WADL URL URL to WADL file (describing API interface)
The API is now ready to be published. This is done by a user in the publisher role.
Versioning the API
Publishing the API
- Log in to the API Publisher Web application as apipublisher.
- Click on the
PhoneVerificationAPI. Note that you can now see a tab as API Lifecycle in the API Publisher UI.
- Go to the API Lifecycle tab and select the state as PUBLISHED from the drop-down list.