Request Dev Account
API Reference

upSWOT API Reference

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

upSWOT APIs are RESTful, featuring predictable and resource-oriented URLs with standard HTTP response codes, authentication, and verbs. They are stateless. All requests are validated against the API token, which can be obtained using the get token method.

With upSWOT API, you can create a connection link to let clients share their business data or use Webhooks to send it to a specific URL or web application when it rolls in. Furthermore, you can leverage raw and normalized business data to build internal solutions and ready-to-use APIs to create custom experiences for your end users.

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 integrations 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.

Follow these simple instructions to make your first call in minutes, or keep reading to learn more.

Host

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

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

Within a multi-tenancy environment, 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 this: 

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

Request and Response format

upSWOT APIs use the create, read, update, and delete (CRUD) basic operations through POST, GET, PUT, and DELETE requests and return responses in a standard 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.