Visión general de la API abierta

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. Más información 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.

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

1. Haga clic en Configuración
2. Haga clic en Documentación de la API
3. Introduzca su contraseña
4. Haga clic en Confirmar
   
5. Seleccione la función que desee mostrar sus API
   
6. 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",
      "tipo": "proyectos",
      "atributos": {
        "id": "aqbqod",
        "name": "Nombre de su proyecto",
        "página de inicio": "",
        "country": null
        "projectnumber": null
        "descripción": null
        "ciudad": null
        "código postal": null
        "calle": null
        "autor-id": "pxpp",
        ...
      }
    }
  }

Conceptos básicos de la API

Conozca los conceptos fundamentales de nuestras API. Obtenga más información en Conceptos fundamentales de las API.

Tutoriales API

Explore los tutoriales paso a paso sobre cómo utilizar nuestras API en las siguientes áreas:

Tutoriales API para puntos finales de usuario

Tutoriales de la API para los puntos finales del proyecto

Tutoriales de API para Tickets Endpoints

Tutoriales de API para puntos finales de documentos

Tutoriales API para puntos finales de programación

Cambios en la API

Revise las últimas actualizaciones y cambios de nuestras API. Lea más en API Changelog.