Skip to content

Documentation for SolveXia Public API.

Notifications You must be signed in to change notification settings

solvexia/solvexia-api-docs

Repository files navigation

SolveXia API Docs

This is an official repository for the SolveXia Public API documentation. Please follow this repository to see the changes over time.

For bug reports or change proposals for APIs please use issues, or create pull requests.

Overview

SolveXia APIs allow users to manage and control their data in SolveXia system programmatically and extend SolveXia capabilities in new and powerful ways. SolveXia APIs use the OAuth 2.0 protocol for authentication and authorization. SolveXia supports two main flows: Client Credentials flow for the server-to-server communication and Authorization Code flow for client-side integration scenarios.

Gettings started

In order to get started using SolveXia Public API you need to create an application in SolveXia API portal.

Register SolveXia Application

Any application that is intended to access SolveXia Public API must have authorization credentials that identify the application to SolveXia authorization server.

Create authorization credentials for your app:

  1. Navigate to SolveXia API portal from the user dropdown menu.
  2. Click "Create new application".
  3. Specify the name and callback URL. Click "Create application".
  4. If the creation is successful you will see Client Id and Client Secret credentials generated.
  5. Copy credentials and store them safely. You will not be able to see Client Secret again unless you generate a new one.

OAuth

The following pages detail the OAuth API's that govern OAuth authorization flows, in order to be able to generate tokens to use SolveXia APIs.

OAuth APIs

Solvexia APIs

The following pages detail the Solvexia API's to manage client resources in SolveXia automation system.

Process APIs
Process Run APIs
Data Step APIs
Table APIs
File APIs
User APIs
User Group APIs