Documentación API

Esta es la documentación disponible para los API endpoints, construidos con REST architecture. Todos los API endpoints devuelven una JSON response con el estandard HTTP response codes y necesitan una Bearer Authentication via API Key.

 

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

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

Errores

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

{
    "errors": [
        {
            "title": "No tienes acceso a la API.",
            "status": 401
        }
    ]
}
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 velocidad excedido
500 Error interno del servidor: esto significa que hay un problema de nuestro lado
All API endpoint results work with the UTC timezone unless specified otherwise.
User
Links
Links statistics
Proyectos
Pixels
Páginas Splash
Códigos QR
Datos
Notification handlers (Notificadores)
Dominios web
Mis equipos
Team members
Teams' member
Pagos de la cuenta
Logs de la cuenta