OASYS API Documentation

Integrate OASYS with your applications using our powerful REST API

Quick Navigation
API Overview
The OASYS API provides programmatic access to all core platform features

Base URL

https://api.oasys.com/v1

Authentication

Bearer Token (API Key)

Response Format

JSON with HTTPS

Authentication
Authenticate your requests using API keys

Get Your API Key

  1. Log in to your OASYS dashboard
  2. Navigate to Settings → API Keys
  3. Click "Generate New Key"
  4. Copy and securely store your key

Authorization Header

Authorization: Bearer YOUR_API_KEY

Security Best Practices

  • • Never expose API keys in client-side code
  • • Use environment variables to store keys
  • • Rotate keys regularly
  • • Use different keys for development and production
API Endpoints
Complete reference of available endpoints
GET
/transactions

List all transactions

limit
offset
status
date_from
date_to
POST
/transactions

Create a new transaction

amount
currency
description
category
GET
/invoices

List all invoices

limit
offset
status
customer_id
POST
/invoices

Create a new invoice

customer_id
amount
currency
items
GET
/reports/financial

Generate financial reports

type
period
format
POST
/documents/process

Process documents with AI

file
type
auto_categorize
GET
/customers

List all customers

limit
offset
search
POST
/webhooks

Configure webhooks

url
events
secret
Code Examples
Get started quickly with these code samples
// Install the SDK
npm install @oasys/sdk

// Initialize the client
import { OasysClient } from '@oasys/sdk';

const client = new OasysClient({
  apiKey: 'your_api_key_here',
  baseUrl: 'https://api.oasys.com/v1'
});

// Get all transactions
const transactions = await client.transactions.list({
  limit: 50,
  status: 'completed'
});

// Create an invoice
const invoice = await client.invoices.create({
  customer_id: 'cust_123',
  amount: 1000,
  currency: 'USD',
  items: [{
    description: 'Consulting services',
    quantity: 1,
    price: 1000
  }]
});
Rate Limits
API usage limits by subscription plan

Starter

1,000

requests per hour

Growth

10,000

requests per hour

Enterprise

Unlimited

custom limits available

Need API Support?

Our technical team is here to help you integrate successfully.