Quickstart

This guide will get you all set up and ready to use the HUB 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 powerful REST API.

Getting started

To get started, register at the hub and create a new POS. Configure it for the PSP that you use. Read about how to make requests for the resources you need to access using our HTTP APIs, plug-ins or dedicated client SDKs.

Before you can make requests to the HUB API, you will need to grab your API key from your POS in the HUB. You can find them all in your POS overview .

Choose your client

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

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

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 HUB API. Below, you can see how to send a GET request to the Guardian endpoint to get a new accesstoken for your POS.

GET

/v1/guardian

curl -G https://payocityhub.com/api/v1/guardian \
  -H "Authorization: Bearer {token}"

Read the docs for the guardian 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 HUB API:

Going into production

When you're ready to go into production, you'll need to follow the steps below;

Open your POS
Click on the POS you want to go live with, and click on the "settings" Button
Enable Production/Live and enter the configuration data from your PSP.
Click on "Save" and your POS is now configured for production.