Interfaces de programación de aplicaciones (API) de Verify

Se puede acceder a las interfaces de programación de aplicaciones (API) de Verify y utilizarlas para el desarrollo de aplicaciones internas.

Soporte Para obtener más información, consulte la documentación de la API en el IBM® Security Verify Documentation Hub.

Formación de IBM Vea un Verify vídeo de la API en IBM.

Métodos HTTP

Cada recurso de API se identifica por un identificador uniforme de recursos (URI) y se accede al mismo utilizando los siguientes métodos HTTP estándares. Los métodos HTTP indican la acción prevista sobre un objeto.
Tabla 1. Métodos HTTP
Método HTTP Descripción
GET Recupera un recurso o una relación en el URL especificado.
  • Una solicitud en el nivel de URL del recurso ( <resource-noun> ) recupera todas las instancias, sujetas a restricciones de búsqueda y paginación (véase la sección de búsqueda).
  • Una solicitud a nivel de ID de recurso (<resource-noun>/<resource-id>) devuelve un recurso individual.
  • Una solicitud a nivel de nombre de relación (<relationship>) recupera todas las instancias de relación, sujetas a restricciones de búsqueda y paginación.
  • El código de estado de respuesta predeterminado es 200.
  • La paginación del resultado se puede personalizar añadiendo un parámetro de consulta como "count" con un valor máximo de 1000.
  • Una solicitud a nivel de ID de relación (<relationship>/<relationship-id>) devuelve una instancia de relación individual.
POST Crea un recurso o una relación a nivel de URL especificado.
  • Una solicitud a nivel de la URL del recurso ( <resource-noun> ) crea el recurso.
  • Una solicitud a nivel de ID de relación (<relationship>) crea la nueva relación.
  • Se puede utilizar para la creación de carga en bloque.
PUT Actualiza un recurso o una relación en el URL especificado.
  • Una solicitud a nivel de URL del recurso ( <resource-noun> ) actualiza el recurso.
  • Una solicitud a nivel de ID de relación (<relationship>) actualiza la nueva relación. No todas relaciones pueden modificarse, por lo que en algunos casos esto se puede considerar una solicitud errónea.
  • Una solicitud para cambiar información de solo lectura (como el identificador de recurso o de relación) se considera una solicitud errónea.
PATCH

Se utiliza para las actualizaciones parciales de un recurso.

  • Una solicitud a nivel de URL tipo de recurso ( <resource-noun> actualiza sólo los deltas de las propiedades que se proporcionan en la solicitud el recurso especificado.
  • El tipo de contenido para PATCH es application/json-patch+json.
  • Si se especifica una operación de supresión con el identificador principal (ID exclusivo o propiedad que se correlaciona con una clave primaria), se suprime todo el objeto.
DELETE Elimina un recurso o una relación en el URL especificado.
Nota: Para la supresión de bulkload, utilice PATCH.