https://github.com/skpassegna/freemius-api-docs

Freemius API documentation
https://github.com/skpassegna/freemius-api-docs

freemius

Last synced: about 1 month ago
JSON representation

Freemius API documentation

• Host: GitHub
• URL: https://github.com/skpassegna/freemius-api-docs
• Owner: skpassegna
• License: mit
• Created: 2024-10-29T05:10:15.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-11-30T16:52:38.000Z (5 months ago)
• Last Synced: 2025-01-21T22:42:47.263Z (3 months ago)
• Topics: freemius
• Homepage: https://freemius.com/help/documentation/api/
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Freemius API Documentation

Welcome to the Freemius API documentation! This comprehensive guide will help you integrate and interact with the Freemius API.

## Introduction

The Freemius API allows you to:

- Manage products

- Handle license verifications

- Create custom integrations with your SaaS

## Authentication

The API uses Bearer authentication. You can obtain your API Key from the Freemius Developer Dashboard for a product or a store.

## API Base URL

Production API: `https://api.freemius.com/v1`

## Documentation Structure

1. [Getting Started](./01-getting-started.md)

   - Introduction and Overview

   - Requirements

   - Quick Start Guide

2. [Authentication](./02-authentication.md)

   - Bearer Authentication

   - Security Best Practices

3. [Core Concepts](./03-core-concepts.md)

   - Products

   - Licensing

   - Users and Installations

4. [Products](./04-products.md)

   - Product Management

   - Settings

   - Version Control

5. [Licensing](./05-licensing.md)

   - License Management

   - Activation/Deactivation

6. [Installations](./06-installations.md)

   - Installation Management

   - Updates

   - Clone Handling

7. [Users](./07-users.md)

   - User Management

   - User Operations

8. [Payments](./08-payments.md)

   - Payment Processing

   - Transaction Management

9. [Subscriptions](./09-subscriptions.md)

   - Subscription Management

   - Subscription Lifecycle

10. [Carts](./10-carts.md)

    - Cart Management

    - Checkout Process

11. [Coupons](./11-coupons.md)

    - Coupon Management

    - Discount Handling

12. [Trials](./12-trials.md)

    - Trial Management

    - Trial System

13. [Webhooks](./13-webhooks.md)

    - Event System

    - Event Types

14. [Advanced Topics](./14-advanced-topics.md)

    - Best Practices

    - Error Handling

## OpenAPI Specification

For more details, you can refer to the [Freemius API OpenAPI Specification](https://freemius.com/help/documentation/api/).

## Terms of Service

For detailed terms of service, please visit: https://freemius.com/terms/

## Support

For support inquiries:

- Website: https://freemius.com

- Email: [email protected]