Using the Evolution APIs

Modified on Wed, 15 Apr at 2:06 PM

Overview

This document provides an overview of how to connect and interact with the Evolution APIs.

OpenAPI Specification

The Softbase Evolution APIs conforms to the OpenAPI specification. This endpoint does not require authentication. The specification is available in both HTML and JSON:

HTML: https://api.dms.softbaseevolution.com/swagger/index.html

JSON: https://api.dms.softbaseevolution.com/swagger/v1/swagger.json

Authenticating

The Evolution APIs uses token-based authentication so before you make any API requests, you need to obtain a token. The username and password are specified in the body. You must also send the tenantId in a header named SoftbaseTenantId

POST /api/tokenauth/authenticate
SoftbaseTenantId {{tenantId}}
{
    "userNameOrEmailAddress" : "{{user}}",
    "password" : "{{pass}}"
}

Sample Success:

{
    "result": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy...",
        "encryptedAccessToken": "wNYmO41/48SHNstaLVXxHCCre29BZQl1NhC6NM3R3rzpXtPQxVzH6jEzA...",
        "expireInSeconds": 86400,
        "shouldResetPassword": false,
        "passwordResetCode": null,
        "userId": 130,
        "requiresTwoFactorVerification": false,
        "twoFactorAuthProviders": null,
        "twoFactorRememberClientToken": null,
        "returnUrl": null,
        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8y...",
        "refreshTokenExpireInSeconds": 31536000
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}

Once you have obtained a token, you need to send it in your Authorization header as a bearer token with every request. An example Authorization header is below. You do not need to send the SoftbaseTenantId header with each request. Only the authorization endpoint requires it.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....4WipCYrCN2tsmUJGrobJ2fql6_0q7iiOO0Qt5oIplvU

How to Inspect a Web Page to View API Calls and Request Body

Step 1: Open Developer Tools

Open Evolution in your browser.
Right-click anywhere on the page.
Click Inspect

Network

AI-generated content may be incorrect. Step 2: Go to the Network Tab

In the Developer Tools panel, click the Network tab.

Step 3: Start Recording Activity

Make sure the record button (●) in the top-left is red (recording).
If it is not, click it to start recording.
Check the box for “Preserve log” (this keeps requests from disappearing).

Step 4: Perform the Action

Go back to the main page.
Perform the action you want to track (for example: saving a record, updating a record, searching for a record, etc.).
You will start to see requests appear in the Network tab.

Step 5: Filter for API Calls

In the Network tab, click “XHR” or “Fetch”
(this filters to API calls only).

Step 6: Inspect the API Call

Click on the request.
- Example: When saving a new Equipment record you will see a request named 'Add'.
A new panel will open with details.

Key tabs to review:

Headers

Shows the URL (endpoint) being called
Shows the HTTP method (GET, POST, PUT, etc.)

Payload / Request

This shows the body being sent to the API to create, update, or retrieve information.

Response

Shows what the system returned
Helpful for errors or validation messages

Tips

Some actions trigger multiple API calls, so you may need to check a few entries.
Look for POST or PUT requests when trying to find data being submitted.

Attached Examples and Use Case

Equipment_Add_Example_With_Auth:

This is a Postman collection that shows how to call the Softbase Evolution API to add equipment. It first authenticates to get a token, then uses that token to call the Equipment Add endpoint and create a new equipment record in Evolution.

Attach_AP_Image_Example:

This is a Postman collection that shows how to upload an AP invoice image into Evolution by calling the DocumentCenter AddApInvoiceImage endpoint and sending form data such as vendor number, invoice number, file name, and the file itself. It does not include authentication, so it assumes a valid bearer token is already set.

Attachments (2)

json

Equipment_Add_Example_With_Auth.json
4.9 KB

json

Attach_AP_Image_Example.json
1.2 KB