An API prototype is created for the purpose of early promotion and testing. You can deploy a new API or a new version of an existing API as a prototype. It gives subscribers an early implementation of the API that they can try out without a subscription or monetization, and provide feedback to improve. After a period of time, publishers can make changes the users request and publish the API.
The examples here use the API
PhoneVerification 2.0.0, which is created in the previous tutorial.
- Log in to the API Publisher and select the API (e.g.,
PhoneVerification 2.0.0) that you want to prototype.
Click the Lifecycle tab of the API and click Deploy as Prototype. After creating a new version, you typically deploy it as a prototype for the purpose of testing and early promotion.
Tip: Leave the Require Re-Subscription check box cleared if you want all users who are subscribed to the older version of the API to be automatically subscribed to the new version. If not, they need to subscribe to the new version again.You can choose to deprecate old versions of this API at this stage by selecting the Deprecate Old Versions check box.
Log in to the API Store and click the newly prototyped API.
- The APIs Overview page opens. Note the following:
- There are no subscription options.
- There are two sets of URLs (with and without the version). This is because you marked the 2.0.0 version as the default version in step 4 of the previous tutorial.
- Other features like documentation, social media and forums are available.
Click the API Console tab and note that the POST method is not available as we removed that in the new version.
Let's invoke the prototyped API.
In the API Console of the prototyped API, expand the GET method, give the parameter values and invoke the API.
Note the response that appears in the console. You do not have to subscribe to the API or pass an authorization key to invoke a prototyped API.
Similarly, try to invoke the 1.0.0 version of the API without an access token and note that you get an authentication error as "Missing credentials."
In this tutorial, you have prototyped an API and tested it along with its older and published versions. In the next tutorial, you publish the prototyped API and deprecate its older versions.
You can also tryout the Create an API with an Inline Script tutorial to learn how to create a prototyped API using a different method.