Get started using the API

This guide will help you get started with the Tuxopay API by creating your first API token and making your first API call.

Prerequisites

Before you begin, make sure you have:

• A Tuxopay account (if you don't have one, sign up here)
• Access to your Tuxopay dashboard
• At least one shop configured in your account

Creating an API Token

To use the Tuxopay API, you'll need to create an API token first.

1. Log in to your Tuxopay dashboard

   Navigate to orchestrator.tuxopay.com and sign in with your credentials.

2. Go to Team Settings

   In your dashboard, navigate to the Team Settings section. This is where you can manage your API tokens and other team-related configurations.

3. Create a new API Token

   Important: Your API token will only be displayed once. Make sure to copy and store it securely. You won't be able to see it again after closing the dialog.

   In the Team Settings page:

   • Look for the API Tokens section
   • Click on "Create New API Token" or similar button
   • Give your token a descriptive name (e.g., "Production API", "Development Token")
   • Click "Create Token"

4. Save your token securely

Using Your API Token

Once you have your API token, you can start using the Tuxopay API. The typical workflow involves two main steps:

Step 1: Initiate a Payment Flow

To process payments, you'll need to initiate a payment flow. This creates a payment session that your customers can use to complete their purchase.

Learn how to create and configure payment flows in our Payment Flows guide.

Step 2: Handle Webhook Events

After initiating a payment flow, you'll receive webhook notifications about payment status changes and other important events. Make sure to:

1. Configure webhook endpoints in your payment flow
2. Set up your server to receive and process webhook events
3. Verify webhook signatures for security

For detailed information on webhook events and how to handle them, see our Webhook Events documentation.

Next Steps

Now that you understand the basic workflow:

1. Create your first payment flow
2. Set up webhook handling
3. Test your integration using the "Test Payment" action in each flow.
4. Go live with your payment processing