Request Dev Account

upSWOT API Reference

Welcome to the upSWOT Developer Platform! Use our APIs to create a seamless experience for your users!

Our APIs are based on a RESTful approach. They are stateless — all requests are validated against the API token, which can be obtained using the get token method. They feature predictable and resource-oriented URLs and use standard HTTP response codes, authentication, and verbs.

With upSWOT API, you can create a connection link that allows clients to share their business data. You can use Webhooks to send this data to a specific URL or web application when it rolls in. Furthermore, the raw and normalized APIs allow you to retrieve business data for building internal solutions or use upSWOT ready-to-use APIs to create your custom user experience.

Use Cases

Why you should use our REST APIs:

  • Build unique UI/UX solutions with our APIs based on Raw, Normalized, and Ready-To-Use data.
  • Utilize data from 100+ SaaS business applications using one API interface.
  • Create a seamless experience for the end users to share business data securely.

Getting Started

This is where the magic begins! The following steps will help you get started with your journey toward creating some excellent integration using the API:

  1. Get your Sandbox developer account
  2. Obtain your JWT access token
  3. Use the access token to make your API requests.

You can follow the Getting Started tutorial to learn how to make your first API call in minutes.

Host

The upSWOT API has two base URLs for Sandbox and production.

📘

Custom Base URL

upSWOT API offers two deployment options: SaaS (upSWOT site) or CPE (customer premises equipment). Therefore, the host URL may vary for different environments.

Sandbox Base URL

For all sandbox API calls, use the following URL:

https://sandbox.upswot.com

Production Base URL

https://app.upswot.com

Tenants

The upSWOT solution is available as SaaS and supports multi-tenancy architecture - an ecosystem in which a single environment can serve multiple tenants using a scalable architecture.

In the multi-tenancy ecosystem, all tenants share a single, common infrastructure and code base that is centrally maintained. Each tenant is integrated physically but separated logically. Here is the URL structure that upSWOT uses for managing this type of architecture: https://{provider_name}.upswot.com/admin/{tenant_alias}

For Sandbox development, use admin default tenant. The full URL will look like this:

https://sandbox.upswot.com/admin

Production will look like: 

https://app.upswot.com/admin/{tenant_alias}

Request and Response format

Base, Normalized, and Ready-to-use APIs use the HTTP protocols POST, PUT, GET, and DELETE for requests. They return responses in JSON data format.

Errors

Error handling varies depending on the API or tool you're using. For example, if your request causes an error, the response will contain an error object with information to help you resolve the problem. For Webhooks, if our request to your URL or web application fails for any reason, we'll keep trying.

For details about how our APIs handle errors, see the Errors page.