17 May 2018

Publishing an API

How do I publish my API on Fortellis?

To add a new API to the Fortellis platform you must first publish it. Publishing an API involved creating a Swagger 2.0 specification for your API and submitting it to Fortellis for review. Let's walkthrough that process. 

The first thing you need is to be a registered Fortellis user and to be logged in to the Developer Network. 

Click on the My APIS link at the top right of the page

This will take you to My APIs where you will be able to see the status of your submitted APIs as they are reviewed and approved by Fortellis. This is also where you will be able to see statistics about the usage of your published APIs.

From this page click the Publish an API button. This will take you to the Publish an API form. Here we will collect information about your API along with the Swagger 2.0 specification that defines your API.

The first section, Specification Details, deals with specifics about your API. The domain helps us to categorize the API to make it easier for developers to find it on Fortellis. API Name is the name you would like to give your API. This should be descriptive enough that a developer has a good idea what your API will be able to do. Description should give some more details on your API. Access Level allows you to set the API as public so that all users can see it or private to limit access to you or your organization. Version is to select a version for your API and Region will be used for localization or region locking if necessary. Specification Upload is the Swagger 2.0 specification file that defines your API.

The next section is where you will enter your contact details. These will be used if Fortellis needs to contact you during the API review process.

The last sections are Privacy and Consent and Pricing. This is where you will attach documents specifying the Privacy Policy, Terms and Conditions, and Pricing Model that will be used by your API.

Once you have filled in all of the fields and attached all of the necessary files and documents click the Submit for Review button. This will submit all of the information you have entered and begin the review process by Fortellis. During this process your API specification and information will be reviewed to ensure it matches our guidelines. You will be notified of approval, rejection, or if we have questions via email. You can also see the progress from the My APIs page as the API is reviewed.

Once the API is approved it will be published on Fortellis and available for developers to try it out from our API Docs page.

Post by Trentin Priebe