• Zapping Access Documentation
  • Introduction
  • Main Endpoints
  • API Swagger URL
  • About Partner Keys (partner_key_1 and partner_key_2)
  • Hardbundle Partner Endpoints
    • Create Customer
    • Get Customer Information
    • Update Customer
    • Delete Customer
    • Get Hardbundle Plans
  • Bundle Partner Endpoints
    • Create Customer (Bundle)
  • Partner Addons Endpoints
    • Get Addon Plans
    • Update Customer Addons
  • Data Models
    • UserPartnerCreate
    • UserPartnerGetter
    • UserPartnerUpdate
    • PartnerUserAddonsUpdate
    • PartnerPlan
    • ResponseObject
    • AddonsArray
  • Rate Limiting and Security
  • Additional Notes

Introduction

The Zapping Access API is designed for partners to manage users on the Zapping platform. This API provides functionality for user management, including registration, retrieval, updating, and deletion of user accounts. It also offers access to plan information for different service types.

API Version: v1-oas3 Base URLs:

• Staging: https://staging-access.zappingtv.com/api
• Production: https://access.zappingtv.com/api

Authentication: The API uses Bearer Token authentication. All requests must include a valid JWT token in the Authorization header.

Main Endpoints

The API is structured around three main partner types:

• Hardbundle Partner
• Bundle Partner
• Partner Addons

Each partner type has specific endpoints for managing customers and retrieving plan information.

API Swagger URL

<aside> 💡 http://api-docs.zappingtv.com

</aside>

About Partner Keys (partner_key_1 and partner_key_2)

The Zapping Access API uses a flexible identification system through partner_key_1 and partner_key_2. These keys are fully customizable by the partner, allowing for seamless integration with existing user management systems. Here are the key points about these identifiers:

1. Customization:
   • partners have full control over what values to use for these keys.
   • They can be any unique identifier that the partner uses in their system.
2. Flexibility:
   • partner_key_1 and partner_key_2 can represent different types of identifiers, such as:
     • Customer ID
     • Email address
     • Phone number
     • National identification numbers (e.g., CPF in Brazil, RUT in Chile)
     • Account numbers
     • Any other unique identifier used by the partner