Concepto: API de REST de Adaptive Planning

Un cliente invoca una llamada API enviando una solicitud HTTP POST al punto final principal de los servicios web de Adaptive Planning. El punto de conexión incluye un número de versión que indica la versión de API que se está utilizando. La versión actual de la API de Adaptive Planning es la v40. Si su instancia utiliza autenticación regional fuera de EE. UU., las URL de autorización y los puntos finales de API varían según la región. Consulte Referencia: URL de autenticación regional.

Las versiones de API suelen actualizarse con las nuevas versiones de producto de Adaptive Planning, aunque no todas las versiones de producto dan como resultado una nueva versión de API. Workday admite la versión actual durante al menos un año después del lanzamiento de la versión de API posterior.

Para obtener un historial de cambios de API, consulte Cambios de API por versión.

La solicitud HTTP POST contiene datos de publicación en un documento XML. Este documento XML incluye secciones estándar presentes en cada llamada de método de API y secciones específicas de cada llamada de método de API. El servidor de Adaptive Planning procesa la llamada al método API y devuelve los resultados como otro documento XML. Al igual que la solicitud, el documento XML de respuesta incluye secciones que son las mismas para cada método de API y secciones que son específicas de cada método de API.

Toda la recuperación de datos utiliza una búsqueda. La persona que llama especifica los criterios para que coincidan con una serie de elementos, y el servidor responde con una lista de entidades de metadatos o datos que coinciden con los criterios. La creación y actualización de datos utilizan una carga masiva de datos, también enviada a través de una directiva POST.

Todas las solicitudes de API están cifradas porque deben utilizar el protocolo web HTTPS. Las credenciales de autenticación del usuario se transmiten a Adaptive Planning como parte del cuerpo de la solicitud de servicios web. Esto significa que la capa web cifra el ID de conexión y la contraseña de un usuario antes de que abandone el equipo que genera la solicitud de servicios web y solo los descifra cuando el servidor de destino los recibe.

La autenticación de un usuario en una solicitud de API no crea una sesión persistente para ese usuario; cada llamada de servicio web independiente debe autenticar a su usuario por separado.

Además, los métodos del servicio web restringen el resultado de cada llamada al conjunto de datos visible para el usuario que realiza la solicitud. Ejemplo: el método de servicio web exportData limita los datos devueltos a los datos que se encuentran en los niveles que posee el usuario que llama.