Skip to content
Last updated

Getting Started

This guide will walk you through everything you need to start using the Aritma APIs.

Prerequisites

Before you can make API calls, you need:

  1. A tenant — your organization's account on the Aritma platform
  2. Client credentials — a CLIENT_ID and CLIENT_SECRET for authenticating API requests
Need credentials?

Contact Aritma support to set up your tenant and obtain client credentials.

Authenticate

All Aritma APIs use OpenID Connect with OAuth 2.0 for authentication. Use your client credentials to obtain an access token via the token endpoint.

EnvironmentEndpoint
Developmenthttps://id.dev.aritma.io/connect/token
Productionhttps://id.aritma.io/connect/token

Request an access token

cURL
curl -i -X POST https://id.dev.aritma.io/connect/token \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d grant_type=client_credentials \
    -d client_id=$CLIENT_ID \
    -d client_secret=$CLIENT_SECRET \
    -d scope=YOUR_SCOPES

Response

{
  "access_token": "<token>",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "YOUR_SCOPES"
}

Use the access_token in the Authorization header for all subsequent requests:

Authorization: Bearer <token>

The available scopes depend on which API you are integrating with. Refer to the authentication section of each API for details.

Next steps

Now that you can authenticate, explore the API that fits your use case:

  • Banking API — account information, payments, and consent management
  • Events API — event-driven integrations and webhooks
  • ERP Hub — connect to accounting systems, book payments, and retrieve open posts
  • Control — reconcile bank data with ERP data (balances, transactions, and open posts)