Skip to main content

Getting Started

Welcome to MAES Platform! This guide will help you make your first API call in under 5 minutes.

Prerequisites​

  • A MAES Platform account
  • Your MAES credentials (username & password)
  • Node.js >= 18.0.0

Step 1: Create an Account​

Visit the dashboard and create your account:

Dashboard: https://maes-platform.nuvoni.eu

Step 2: Create a Project​

  1. Click "New Project" in the dashboard
  2. Enter your project name (e.g., "My Fleet App")
  3. Add your MAES credentials (username & password)
  4. Click "Create Project"

Your project is now ready with both Sandbox and Production environments.

Step 3: Generate an API Key​

  1. Open your project
  2. Go to Sandbox environment
  3. Click the "Integrate" tab
  4. Click "Create API Key"
  5. Copy your API key immediately — it won't be shown again!

Your key will look like: sk_sandbox_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456

Step 4: Install the SDK​

npm install @nuvoni/maes-sdk
# or
yarn add @nuvoni/maes-sdk
# or
pnpm add @nuvoni/maes-sdk

Step 5: Make Your First API Call​

import { MaesClient } from '@nuvoni/maes-sdk';

const client = new MaesClient({
  apiKey: 'sk_sandbox_xxxxx', // Your API key
  projectId: 'your-project-id', // From dashboard URL
});

// List all cards
const { docs, total } = await client.cards.list();
console.log(`Found ${total} cards`);

// Get a specific card
const card = await client.cards.get('card-id');
console.log(`Card ${card.cardNumber}: ${card.status}`);

Step 6: Explore the API​

Now that you've made your first call, try these operations:

// Enable fuel authorizations for a card
await client.cards.enable('card-id');

// Disable fuel authorizations
await client.cards.disable('card-id');

// Activate a new card
await client.cards.activate('card-id', {
  licensePlate: 'AB-123-CD',
  driver: 'John Doe',
});

Sandbox vs Production​

EnvironmentAPI Key PrefixPurpose
Sandboxsk_sandbox_*Testing with mock data
Productionsk_live_*Real MAES operations
tip

Always develop and test with Sandbox keys first!

Next Steps​