Saltar al contenido principal

GET /api/users/countries

El endpoint GET /api/users/countries permite obtener una lista de todos los países registrados en el sistema con sus códigos ISO de dos dígitos. Esta funcionalidad es útil para llenar listas desplegables o formularios donde se necesita seleccionar un país, asegurando que los datos se mantengan consistentes y actualizados.

Este endpoint es especialmente útil para aplicaciones que requieren información geográfica, ya sea para la creación de perfiles de usuario, configuraciones de cuenta, o cualquier otra funcionalidad que necesite un listado de países.

Detalles de la Solicitud​

Método HTTP: GET URL: /api/users/countries

Parámetros de la Solicitud​

Este endpoint no requiere parámetros en la solicitud.

Autenticación Requerida​

La autenticación requerida para utilizar el endpoint es mediante un token Bearer. Este método de autenticación implica que cada solicitud debe incluir un encabezado de autorización con un token de acceso válido. Este token Bearer actúa como una credencial que verifica la identidad del usuario o aplicación que realiza la solicitud, asegurando que solo las entidades autorizadas puedan modificar la información del usuario. Al requerir este tipo de autenticación, el sistema garantiza un nivel elevado de seguridad y control de acceso, protegiendo los datos de los usuarios contra accesos no autorizados.

Ejemplo de Solicitud​

GET /api/users/countries HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer {your_auth_token}

Parámetros de Respuesta​

La respuesta de este endpoint contiene una estructura que incluye el estado de la solicitud y una lista de países. A continuación se detallan los campos de la respuesta:

CampoTipoObligatoriaDescripción
successbooleanNoIndica si la solicitud fue exitosa.
errorstringNoContiene el mensaje de error en caso de que success sea false.
apiUsageintegerNoUso actual de la API por el usuario.
apiDailyUsageintegerNoUso diario de la API por el usuario.
countriesobjectNoUn objeto con los códigos ISO de dos dígitos y nombres de los países.

Ejemplo de Respuesta Exitosa​

{
 "success": true,
 "apiUsage": 100,
 "apiDailyUsage": 10,
 "countries": {
 "US": "United States",
 "CA": "Canada",
 "AR": "Argentina",
 "BR": "Brazil",
 "GB": "United Kingdom",
 "CO": "Colombia"
 }
}

Ejemplo de Respuesta de Error​

{
 "success": false,
 "error": "Autenticación fallida. Token inválido.",
 "apiUsage": 100,
 "apiDailyUsage": 10
}