Quickstart

This guide will get you all set up and ready to use the Reportyy API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our REST API.

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, Reportyy offer a client for JavaScript (more coming soon!). In the following example, you can see how to install each client.

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

Making your first API request

After picking your preferred client, you are ready to make your first call to the Reportyy API. Below, you can see how to send a POST request to the Generate PDF endpoint.

curl -X POST https://api.reportyy.com/api/v1/templates/:uid/generate-sync \
  -H "Authorization: API-Key rpty_Q6huXECEU..." \
  -H "Content-Type: application/json" \
  -d '{"date": "14 Feb 2023", "total": "£14.00"}'

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 Reportyy API:

• Grab your API key from the Reportyy dashboard
• Check out the Generated PDFs endpoint
• Learn about the different error messages in Reportyy