Documentación de la API

Aprende a conectar e integrar con nuestra API.

URL base

Autenticación

Todas las solicitudes a la API requieren autenticación mediante una clave API enviada a través del encabezado Authorization como se muestra a continuación.

Authorization: Bearer {api_key}

Ejemplo

curl --request GET \
--url 'https://okk.link/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errores

Nuestra API utiliza códigos de estado HTTP convencionales para indicar el éxito o fracaso de una solicitud.

Ejemplo

{
    "errors": [
        {
            "title": "No tienes acceso a la API.",
            "status": 401
        }
    ]
}

Códigos de estado

200 Solicitud completada con éxito

400 Solicitud incorrecta - Faltan parámetros requeridos o son inválidos

401 No autorizado - Falta la clave API o es inválida

404 El recurso solicitado no fue encontrado

429 Demasiadas solicitudes - Límite de tasa excedido

500 Error interno del servidor - esto significa que hay un problema de nuestro lado

Todos los resultados de los endpoints de la API funcionan con la zona horaria UTC a menos que se especifique lo contrario.

Usuario

Enlaces

Estadísticas de enlaces

Píxeles

Páginas de presentación

Códigos QR

Firmas

Datos

Gestores de notificaciones

Dominios personalizados

Equipos

Miembros del equipo

Miembro de equipos

Pagos de la cuenta

Referred signups

Registros de la cuenta