Peticiones
Realizar una solicitud
Servidor
El servidor para las solicitudes de Web API v1 es siempre https://api.iafcertsearch.org/api/client/v1
Todas las solicitudes deben realizarse a través de HTTPS. La API no admite HTTP.
Encabezado de autorización
Debe proporcionar un encabezado de autorización según se describe en Autenticación.
Verbos HTTP
GET
Obtener un recurso o grupo de recursosPOST
Crear un nuevo recursoPUT
Actualizar un recurso existenteDELETE
Eliminar un recurso existenteOPTIONS
Ver los verbos permitidos para un recurso específico
Encabezado de aceptación
La API proporciona respuestas en formato JSON. Actualmente no requiere el encabezado de aceptación, pero podría hacerlo en el futuro. Si no se establece, la API utilizará application/json
.
Arreglos de datos
Cuando envíe un arreglo de datos en una solicitud GET
, deberá incluir el parámetro varias veces en la URL. El nombre del parámetro no requiere corchetes.
Dar formato a su solicitud
Cuerpo de la solicitud
Cuando envíe datos a un recurso mediante POST
o PUT
, debe enviar su carga útil en formato JSON.
Paginación
Algunos recursos GET
permiten obtener información en lotes. Proporcionaremos los parámetros de la consulta en la documentación del recurso cuando corresponda.
Cuando solicite varios elementos, la solicitud tendrá por defecto un límite de 20
elementos. Puede especificar un límite diferente mediante el parámetro limit
cuando sea necesario. El valor máximo que aceptamos para el parámetro limit
es 100
.
A continuación, puedes ver un ejemplo de una solicitud a la API que recupera los primeros 100 registros según los parámetros limit=100
y offset=0
.
Para recuperar el siguiente lote de registros, incrementa el parámetro de desplazamiento en 1
.
Solicitudes exitosas
Verbo | Objeto de recurso devuelto |
GET | Devuelve un solo objeto de recurso o una matriz de objetos de recurso |
PATCH | Devuelve el objeto de recurso actualizado |
PUT | Devuelve el objeto de recurso actualizado |
DELETE | No se devuelve ningún contenido |
POST | Devuelve el objeto de recurso recién creado |
Last updated