Wyleex Documentación

# Visión general

Nuestra API está expuesta como un servicio HTTP/1 y HTTP/2 sobre SSL. Todos los puntos finales viven bajo la URL https://suscripcion.expreso.ec/api/v1/ y luego generalmente siguen la arquitectura REST.

# Versión actual

Por defecto, todas las solicitudes a https://suscripcion.expreso.ec/api/v1/ reciben la versión v1 de la API.

Tratamos de evitar romper la compatibilidad con versiones anteriores tanto como sea posible.

# Tipo de contenido

Todas las solicitudes deben codificarse como JSON con el encabezado Content-Type: application / json. La mayoría de las respuestas, incluidos los errores, también se codifican exclusivamente como JSON.

Tipo de contenido: application / json
1

# Autenticación

Proporcione su token API como parte del encabezado de autorización.

Si la autenticación no se realiza correctamente, se devuelve el código de estado ** 401 **.

Autorización:  $ TOKEN
1

Después de detectar varias solicitudes con credenciales no válidas en un corto período de tiempo, la API rechazará temporalmente todos los intentos de autenticación para ese usuario (incluidos los que tengan credenciales válidas) con 403 Prohibido.

# Verbos HTTP

Siempre que sea posible, API se esfuerza por usar verbos HTTP apropiados para cada acción.

Verb Description
HEAD Can be issued against any resource to get just the HTTP header info.
GET Used for retrieving resources.
POST Used for creating resources.
PATCH Used for updating resources with partial JSON data. For instance, an Issue resource has title and body attributes. A PATCH request may accept one or more of the attributes to update the resource. PATCH is a relatively new and uncommon HTTP verb, so resource endpoints also accept POST requests.
PUT Used for replacing resources or collections. For PUT requests with no body attribute, be sure to set the Content-Length header to zero.
DELETE Used for deleting resources.

# Paginación

Las solicitudes que devuelven varios artículos se paginarán a 15 artículos de forma predeterminada.

curl 'https://api.example.com/users?page=2&per_page=100'
1

# Limitación de velocidad

Limitamos la cantidad de llamadas que puede hacer durante un cierto período de tiempo. Los límites de velocidad varían y se especifican en el siguiente encabezado en todas las respuestas:

Header Name Description
X-RateLimit-Limit The maximum number of requests you're permitted to make per minute.
X-RateLimit-Remaining The number of requests remaining in the current rate limit window.
X-RateLimit-Reset The time at which the current rate limit window resets in UTC epoch seconds.

Si excede el límite de velocidad, se devuelve una respuesta de error con el estado 429 Too Many Requests..

Estado: 429 Too Many Requests.
1