Superface offers a web based tool builder that allows you to:

Access the Authoring Hub by clicking on Create Tools in your Account menu, or by heading to https://pod.superface.ai/authoring.

authoring-index-f725e8612ef36c2511b39b03be873633.png

Add a new use case/tool

<aside> <img src="/icons/report_gray.svg" alt="/icons/report_gray.svg" width="40px" />

REQUIREMENTS To add a new tool to Superface you will need the a URL for, or a copy of, the OpenAPI Specification for the API of the service you want to connect to.

</aside>

Step 1: Upload documentation

Start by clicking on + Add tool, a popup will appear and you can either paste an Open API Specification, or provide a URL for it (URLs for documentation hosted by Readme.io will also be accepted here).

Remember, only OpenAPI Specification documentation is supported at this time. URLs for standard API documentation pages will not work.

authoring-provider-input-be8bfbb39252d37ed3441632fb674706.png

You don't have to provide a name, however if you want control over the naming you can provide one. Typically the name should be for the service you are creating a tool for (eg. electricity-maps, hubspot, my-company-api).

Clicking Connect tool will index the Open API Specification and get it ready for you to make a tool with. You will see the progress on your screen as well as any errors that may occur.

Step 2: Check the provider

Once indexing is complete you will be redirected to a page similar to the one below.

authoring-check-provider-50caf5077176f8ac7e3ee29bdb294f6d.png

You can check the setup for the Provider by looking at the JSON output. It outlines: