1. Home
  2. Documentation
  3. Using Dropsource
  4. Connecting to an API

Connecting to an API

Dropsource connects to external data via REST APIs. If you have data hosted on the web that you want to connect to in your app, or if you need structured data, you will need an API. You can use third party web services or your own APIs, making requests to send and receive data. To build an API request in Dropsource:

ⓘ Note

If you haven’t set your API up yet, check out the API Tools section for recommended options.

To add an API to your project, open the API tab on the right of the editor and click the plus plus button.

add api

Importing an API Spec

To import an API, you will need to upload or link to an OpenAPI (Swagger) specification that describes the endpoints you want to use in your app. You can import a spec for your own API or for a third party service.

api select

Dropsource will display an indicator of your upload progress – if there are any validation errors you will see details so that you can address the issues and attempt your upload again.

ⓘ Note

If you’re not sure how to create an API specification or need guidance on creating an API, check out Data and Dropsource for tips on getting started. In order to work in Dropsource, your API and specification will need to meet a few requirements.

Once your API is imported you will see it in the API tab – you can delete or update it from here at any time.

api added

When you update an API, Dropsource will attempt to retain the details of any requests you have in the project. For your reference Dropsource will highlight requests and fields that your update has removed.

api field updated

If your API requires authentication you can configure that next, otherwise you can start building requests.

Using a Demo Library API

Dropsource provides a range of demo APIs you can try out – select one from the drop-down list and add it to your project.

library apis

When the API is added you will see it in the API tab. Some of the demo library APIs require authentication, otherwise you can start making requests straight away.

Authentication

If an API requires requests to be authenticated you will see a Set Authentication option in the API tab.
set auth

You can use Basic, API Key, and OAuth2 Password authentication in Dropsource.

auth detail

When you set the authentication details for an API, it applies to all pages in your project.

FAQ: How do I log a user in via API?

Once your auth setup is complete you can start building requests.

Was this article helpful to you? Yes No

How can we help?