Quickstart

Choose your client

Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, Vatly offers clients for JavaScript, Python, and PHP. In the following example, you can see how to install each client.

# cURL is most likely already installed on your machine
curl --version

# Install the Vatly PHP SDK
composer require vatly/vatly-api-php

Check out our list of first-party SDKs

Making your first API request

After picking your preferred client, you are ready to make your first call to the Vatly API. Below, you can see how to send a GET request to the Checkouts endpoint to get a list of all your checkouts. In the cURL example, results are limited to ten checkouts, the default page length for each client.

curl -G https://api.vatly.com/v1/checkouts \
  -H "Authorization: Bearer live_your_api_key_here" \
  -d limit=10

$vatly = new Vatly\Api\VatlyApiClient;
$vatly->setApiKey($key);

$vatly->checkouts->page();

Read the docs for the Checkouts endpoint

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Vatly API:

• Grab your API key from the Vatly dashboard
• Check out the Checkouts endpoint
• Learn about the different error messages in Vatly