Providing SDKs is the shortest path for developers to get started with your API. However, manually writing client code can be difficult, error-prone – and not to mention repetitive. Providing SDKs makes developers more productive and reduces the chances of errors . Furthermore, SDKs allows developers to focus on the core value of an API’s underlying service (e.g. payment processing) while abstracting the remoteness and language specific object mappings of the API’s interface.
Getting the SDKs on your Anypoint API Portals can be achieved with just a couple of simple steps:
- Begin by making sure that your API version on the Anypoint Platform has a RAML definition and a public developer portal. The public portal is necessary as that is the way that APIMatic can get access to your API’s RAML definition.
- Create an APIMatic account. Once you have logged in, navigate to your account settings (by clicking on your user ID at the top right) and you should see an Anypoint Platform option in the menu on the left-hand side. Also note that within the APIMatic account page, the “CodeGen Profile” settings allow you to customize the way your code is generated. As an example, you can specify whether to generate synchronous or asynchronous code in Java and C#. Don’t forget to save the settings, these will be used every time you download code from your Anypoint API Portal.
- Copy and paste the URL of the API Portal associated with your API version into the Anypoint API Portal Url field on the APIMatic page.
- Click “Update ID and Embed Script” and you will see a generated markdown snippet. This markdown snippet has the buttons (with links) to download every type of SDK for your API.
- You can now copy and paste this markdown snippet into the API portal for your API.
After going through these five steps, you are done and your portal editor should display the SDK download as per the example below.
Your portal now exposes SDK downloads for your API and you have just made life for developers that use your APIs much simpler. Enjoy!