Códigos de respuesta

La siguiente es una lista de códigos de respuesta que podrían ser emitidos por los endpoints de la API de Sign In App. En la medida de lo posible, cada endpoint documenta los requisitos específicos de los parámetros y los posibles errores específicos de ese endpoint.

200 OK

Se devuelve para la mayoría de las demás llamadas a la API, incluidas GET, PUT, PATCH y DELETE. Los datos devueltos representarán el recurso solicitado.

201 Created

Se devuelve cuando se crea un nuevo recurso en la API. Se devuelve 201 como confirmación de que la llamada al recurso se ha realizado correctamente. Normalmente la respuesta contiene la entidad recién creada.

401 Unauthorized

Las credenciales de la API utilizadas no existen o no se han podido autenticar. Compruebe que la cabecera authentication está configurada correctamente y con los detalles correctos.

403 Forbidden

Ha fallado una comprobación de permisos para el endpoint especificado para el cliente API que se está utilizando. Compruebe en el portal los permisos asociados para el cliente que se está utilizando.

405 Method Not Allowed

Esto suele deberse a que el endpoint no acepta el verbo HTTP especificado. Compruebe la documentación para ese endpoint y sus métodos HTTP soportados.

422 Unprocessable Entity

Cuando falla la validación de los campos proporcionados en una solicitud, se devuelve un objeto JSON con cada campo que ha fallado y una descripción del motivo.

Object {
String <key>: Array[String]
}

Ejemplo

{
"name": [
"Name is a required field."
],
"mobile": [
"The specified mobile number is not valid."
]
}

429 Too Many Requests

La API de Sign In App implementa el estrangulamiento en todos los puntos finales. Asegúrese de limitar el número de solicitudes a un máximo de 20 por minuto. Si se supera este límite, se devolverá esta respuesta hasta que expire el minuto.

500 Internal Server Error

Si se produce un problema durante la ejecución que no puede devolverse como un mensaje de error útil, la API de Sign In App devolverá este estado. Los sistemas internos están configurados para supervisar estos errores y responder adecuadamente.

503 Service Unavailable

Ocasionalmente realizamos tareas de mantenimiento que pueden requerir un tiempo mínimo de inactividad. Este estado se emite durante ese periodo. Las solicitudes deben ponerse en cola y volver a intentarse más tarde.

© 2024 Sign In App Ltd