API abiertas

Visión general

PlanRadar proporciona API REST seguras que están abiertas a todos los clientes para sus propias integraciones. Además, PlanRadar también proporciona PlanRadar Connect para crear automatizaciones personalizadas e integraciones con aplicaciones de terceros sin necesidad de codificar. Lea más en PlanRadar Connect.

La API REST presenta URL orientadas a recursos, acepta cuerpos de solicitud codificados mediante formularios, devuelve respuestas codificadas en JSON y utiliza códigos de respuesta HTTP y autenticación estándar.

Acceso y permisos

Las API abiertas sólo están disponibles para las cuentas Pro y Enterprise. Más información en Precios y suscripción.

Para utilizar las API abiertas, necesita un usuario interno con el permiso de usuario 'Acceso API'. Más información en Permisos.

Utilice API abiertas

Al utilizar las API, puede enviar hasta 30 solicitudes por minuto. Si supera este límite, se desactivará su token de autorización durante 5 minutos. En caso de requisitos especiales, póngase en contacto con nuestro equipo de asistencia.

Autorización de acceso a la API

Cuando consuma una API, deberá añadir la clave de autorización como valor de cabecera "X-PlanRadar-API-Key". La clave de autorización puede obtenerse generando Personal Access Tokens y utilizándolos para autenticar sus solicitudes de API.

API disponibles

Haga clic en Configuración
Haga clic en Documentación de la API
Introduzca su contraseña
Haga clic en Confirmar
Seleccione la función que desee mostrar sus API
Aparecerá una lista de todas las API relacionadas con esa característica

Actualmente estamos trabajando en la actualización de todas nuestras API a la v2. Le recomendamos que utilice las API v2 si están disponibles. Las API v2 son más rápidas, robustas y flexibles que las API v1.

Ejemplo de solicitud API

He aquí un ejemplo de utilización de las API para llamar a los detalles del proyecto:

URL DE LA API:

GET /api/v1/{customer_id}/proyectos

Cuerpo de la solicitud:

{
 "datos": {
 "atributos": {
 "nombre": "Nombre de su proyecto"
 }
 }
}

Cuerpo de la respuesta:

{
 "datos": {
 "id": "aqbqod",
 "type": "proyectos",
 "atributos": {
 "id": "aqbqod",
 "name": "Nombre de su proyecto",
 "homepage": "",
 "country": null,
 "projectnumber": null,
 "description": null,
 "city": null,
 "zipcode": null,
 "street": null,
 "author-id": "pxpp",
...
   }
 }
}