Introducción

La documentación es la clave para comprender a fondo la api de Pruff.

Convenciones

Solicitudes

La URL base para enviar todas las solicitudes de API es https://api.pruff.com/api/clients. Se requiere HTTPS para todas las solicitudes de API.

Todas las requests serán autenticadas mediante el uso de un api key alfanumérico de 64 caracteres. Este será entregado directamente por Pruff y será enviado a través de los headers de la solicitud.

Los cuerpos de solicitud y respuesta se codifican como JSON.

CONVENCIONES JSON Y QUERY PARAMS

• Los nombres de las propiedades están en camelCase .
• Los valores temporales (fechas y horas) se codifican en cadenas ISO 8601. Las fechas con distinción de hora incluirán el valor de la hora (2020-08-12T02:12:33.231Z), mientras que las fechas sólo incluirán la fecha (2020-08-12).

Paginación

Los endpoints que devuelven listas de objetos admiten solicitudes de paginación mediante params. Por defecto, se devuelven diez elementos por llamada a la API. La respuesta incluirá las propiedades data para los objetos de la respuesta y pagination para los datos de paginación.

Ejemplo:

https://api.pruff.com/api/clients/dummy?page=2?pageSize=5

{
    "data": [
        {
            "dummyOne": "value1",
						"dummyTwo": "value2"
        },
        {
            "dummyOne": "value1",
						"dummyTwo": "value2"
        }
    ],
    "pagination": {
        "total": 7,
        "page": 2,
        "pageSize": 5,
        "totalPages": 2
    }
}

Códigos de estado

Los códigos de respuesta HTTP se usan para indicar clases generales de éxito y error.

Código de éxito

Códigos de error

Varios

Roles

Roles por defecto

Endpoints

Endpoints