Documentation API Yoplanning

Introducción

La API de Yoplanning está estructurada en torno al principio REST. Nuestra API proporciona URL predecibles orientadas a recursos y utiliza códigos de respuesta HTTP para indicar errores y éxito de las llamadas a la API. Aprovechamos las funciones HTTP integradas, como la autenticación HTTP y los verbos HTTP, que los clientes HTTP estándar entienden. Todos los métodos de nuestra API devuelven JSON.

Autenticación

Para comenzar, debe solicitar un token API para poder consultar la API de Yoplanning. Para hacer esto, por favor contáctenos. Una vez que tenga su token en mano, puede comenzar a trabajar con la API. Todos los métodos API requieren autenticación.

Utilizamos un sistema de autenticación estándar basado en tokens. Para autenticarse, simplemente proporcione su token API en el encabezado de cada solicitud de la siguiente manera: Autorización: Token 4804c2cb4d87a13146d4de029f407c82149f2ada. Advertencia: el espacio entre "Token" y el token es importante.

Aquí hay un ejemplo completo usando curl:

curl -H "Content-Type: application/json" https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/clients/8d23503e-041e-4180-98d1-641183bc5ead -H 'Authorization: Token 4804c2cb4d87a13146d4de029f407c82149f2ada'

Si no proporciona un token o el token no es válido, la API responderá con un código HTTP 401 (no autorizado) y le brindará un campo de "detalles" en el JSON de respuesta para ayudarlo a comprender el problema.

Permisos

Cuando solicitó su token API, se le otorgaron permisos específicos en un determinado conjunto de equipos. Esto significa que probablemente no puedas utilizar todos los métodos de la API. Si llamas a la API de Yoplanning sin permisos, la API responderá con un código HTTP 403 (Prohibido).

Limitar consultas

Por motivos de seguridad, el número de solicitudes que puedes realizar es limitado. Puede enviar hasta 5 solicitudes por segundo y 1000 solicitudes por día. Más allá de esta tasa, el servidor responderá con un código HTTP 429 (Demasiadas solicitudes).

Descripción general

Equipo

El equipo es el concepto más fundamental en Yoplanning (que es una herramienta colaborativa). Casi todos los métodos toman un parámetro teamId en la URL, lo que significa que todas las acciones son relativas a un equipo.

UUID

Muchos métodos requieren un parámetro "pk" en la URL. Este es el identificador único del recurso que está intentando recuperar/crear/actualizar/eliminar. Yoplanning utiliza UUID (versión 4) como identificador único para todos los recursos.

Puntos finales HTTP y verbos

Para muchos recursos, hay 2 puntos finales disponibles:

• Uno para acceder a una instancia específica. La URL normalmente termina con <pk>.

• Uno para acceder al administrador de instancias: estos puntos finales utilizan los siguientes verbos HTTP:

  • OBTENER: obtenga una lista de todos los recursos (ver Paginación)

  • POST: crea un nuevo recurso (El identificador será generado por el servidor)

paginación

Para todos los métodos API que proporcionan una gran lista de recursos, se utiliza la paginación. Esto significa que no todos los resultados se darán en una sola consulta. Deberá realizar varias consultas para obtener la lista completa de recursos.

Filtros

Para algunos puntos finales, puede filtrar los resultados agregando parámetros de consulta a la solicitud.

Campos ampliables

Para algunos puntos finales, el objeto de recurso contiene recursos anidados. Para evitar enviar más solicitudes, puede utilizar el mecanismo de extensión.