Documentación de la API

Esta es la documentación para los endpoints de la API disponibles, que están construidos en torno a la arquitectura REST. Todos los endpoints de la API devolverán una respuesta JSON con los códigos de respuesta HTTP estándar y requieren una autenticación Bearer mediante una clave API.

Get your own API Key

URL base

Autenticación

Todos los puntos finales de la API requieren una clave API enviada por el método de autenticación Bearer.

Authorization: Bearer {api_key}

Ejemplo

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

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

Ejemplo

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

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

All API endpoint results work with the UTC timezone unless specified otherwise.

Usuario

Enlaces

Estadísticas de enlaces

Píxeles

Páginas de bienvenida

Códigos QR

Datos

Notification handlers

Dominios personalizados

Registros de cuenta