Skip to content

API Introduction & Authentication

Upkapp is designed to be the central hub for your repetitive tasks and operational controls. However, we understand that modern businesses rely on an ecosystem of software. To help you connect Upkapp with your external tools, IoT devices, or internal dashboards, we provide a lightweight and powerful REST API.

Whether you want to automatically push mileage data from your GPS tracking software into Upkapp Meters or extract work order statuses for custom reporting, the API gives you full programmatic access to your account.

Generating an API Key

You must have a paid account to use the API.

To interact with the Upkapp API, you must first generate a secure API key to authenticate your requests.

  1. Log in to your Upkapp account.
  2. Navigate to Menu > API in the main navigation sidebar.
  3. Click the button to Create New API Key.
  4. Give your key a recognizable name (e.g., Telematics Integration or Internal Dashboard) so you know what it is used for.

⚠️ Security Warning: Save Your Key Immediately

For your security, your API key will only be displayed once immediately after you generate it. Upkapp does not store the key in plain text, meaning we cannot retrieve it for you later.

Please copy the key and store it in a secure location (like a password manager or environment variable file) before closing the window. If you lose your key, you will need to revoke it and generate a new one.

Authenticating Your Requests

Upkapp uses standard Bearer Token authentication. Once you have generated your API key, you must include it in the headers of every request you make to our endpoints.

Every HTTP request must include the following two headers:

  • Content-Type: application/json
  • Authorization: Bearer <YOUR_API_KEY>

Example Request

Here is a basic example of how to format an API request using cURL:

```bash curl -X GET "https://api.upkapp.com/v1/your-endpoint-here" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_API_KEY_HERE"