KicketKicket
Mi cuenta
Guía · Descargas▾
  • Inicio
  • Primeros pasos
  • Autenticación
  • Paginación y sincronización
  • Errores
  • Límites de uso
  • Webhooks
  • Conciliación
  • Modelo de datos
  • Referencia
  • Descargas
  • Cambios

API de Kicket · v1

  • Inicio
  • Primeros pasos
  • Autenticación
  • Paginación y sincronización
  • Errores
  • Límites de uso
  • Webhooks
  • Conciliación
  • Modelo de datos
  • Referencia
  • Descargas
  • Cambios

Descargas

El contrato completo de la API en OpenAPI 3.1: importalo en tus herramientas o generá un cliente con tipos.

El documento OpenAPI

Está siempre al día en https://kicket.club/api/v1/openapi.json. Es público (no pide token) y trae todas las rutas, los parámetros, los objetos, los errores, los permisos y ejemplos de cada respuesta.

Descargar openapi.json
O bajalo desde la terminal
curl -s https://kicket.club/api/v1/openapi.json -o kicket-api-v1.openapi.json

Postman

  1. Tocá Import, pegá la URL del documento y elegí importarlo como colección.
  2. En la colección, pestaña Authorization: tipo OAuth 2.0, Grant type Client Credentials, Access Token URL https://kicket.club/api/v1/oauth/token, tu Client ID y tu Client Secret, Client Authentication Send as Basic Auth header.
  3. Tocá Get New Access Token y después Use Token. Todas las rutas de la colección lo heredan.
Guardá el Client Secret en una variable de tipo «secret» del entorno de Postman, no en la colección: la colección se comparte.

Insomnia

  1. Import › From URL y pegá la URL del documento.
  2. En la colección, Auth › OAuth 2.0, Grant Type Client Credentials, con la Access Token URL de arriba y tu credencial.

Generar un cliente

TypeScript: los tipos con openapi-typescript

Genera los tipos de cada objeto y cada ruta. Lo usás con tu propio fetch, o con openapi-fetch.

Terminal
npx openapi-typescript https://kicket.club/api/v1/openapi.json -o kicket-api.d.ts
Uso
import type { components } from './kicket-api'

type Venta = components['schemas']['Sale']
type Pago = components['schemas']['Payment']

Otros lenguajes: openapi-generator

Genera un cliente completo en Python, Java, C#, Go, PHP y muchos más. Necesita Java instalado (o usá su imagen de Docker).

Terminal
npx @openapitools/openapi-generator-cli generate \
  -i https://kicket.club/api/v1/openapi.json \
  -g python \
  -o kicket-api-python
Los clientes generados no saben de la sincronización incremental ni de los reintentos: esa lógica es tuya. La guía trae una receta lista para copiar.

El archivo de la credencial

Al crear o rotar una credencial, el panel te ofrece bajar kicket-api.env con KICKET_API_URL, KICKET_CLIENT_ID y KICKET_CLIENT_SECRET: son las variables que usan todos los ejemplos de esta guía. Guardalo fuera de cualquier repositorio.

AnteriorReferenciaSiguienteCambios