📘
For the token generation, please dive into the dedicated guide.

Introduction

Authentication allows you to connect a user's Upply account to your internal app or a third party app. This process involves providing your app with a token that's generated by Upply. The token generation mechanism varies depending on whether the app is an internal app or a third party app:

You can request an API key by contacting us. Once you have an API key, you can start making requests to our API.

Using the Token

All requests are authenticated via an API key/token in the query parameter or as a bearer token in the authorization header.

Bearer Token
The API key can be put in the authorization header. This is the recommended approach.

--SANDBOX--
curl --request GET \
     --url 'https://api.sandbox.upply.com/v1/ping' \
     --header 'Authorization: Bearer {Upply API Key}' \
     --header 'accept: application/json'

--PRODUCTION--
curl --request GET \
     --url 'https://api.upply.com/v1/ping' \
     --header 'Authorization: Bearer {Upply API Key}' \
     --header 'accept: application/json'