SOLO REST API Documentation

SOLO REST API Documentation#

Introduction#

The SOLO REST API is a RESTful API that allows you to access Transfer Online’s SOLO system. The API is designed to be simple and easy to use. The API is based on REST principles and uses JSON for serialization and HTTP for communication.

Getting Started#

  • This API documentation is organized by resource type.

  • Each resource type has one or more data representations and one or more methods.

  • You can find each of the resource types listed below, or in the navigation menu to the left.

  • Click on a resource type to view the documentation for that resource type.

Note

Child attributes will be listed will be formatted as “parent.child”.

Authentication (Brief Overview)#

SOLO’s API has three basic authentication characteristics to remember:

  • All requests to the SOLO REST API must be authenticated.

  • SOLO uses OAuth 2.0 (Client Credentials Flow) rather than traditional “API Keys.”

  • You can view and manage your clientId and clientSecret in the SOLO Dashboard.

Quick Authentication Steps#

  1. Obtain Client Credentials

    • In your SOLO Dashboard, you receive a clientId and clientSecret.

  2. Request an Access Token

    • Make a POST request to {{baseurl}}/connect/token

    • Send form-encoded fields:

      grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET

    • You’ll get back an access_token.

  3. Include Token in All Requests

    • Every request must have an Authorization header:

      Authorization: Bearer YOUR_ACCESS_TOKEN

  4. Use the Correct Base URL

    • Sandbox URL: {{baseurl}}/api/v1/

  5. Renew Token as Needed

    • Access tokens expire; re-request them periodically using the same steps above.

Getting Started

Additional Resources

API