Visão geral da API aberta

Visão geral

PlanRadar fornece APIs REST seguras que estão abertas a todos os clientes para suas próprias integrações.
Além disso, o PlanRadar também fornece o PlanRadar Connect para criar automações personalizadas e integrações com aplicativos de terceiros sem codificação. Leia mais em PlanRadar Connect.

A API REST apresenta URLs orientadas a recursos, aceita corpos de solicitação codificados por formulário, retorna respostas codificadas por JSON e usa códigos de resposta e autenticação HTTP padrão.

Use APIs abertas

Ao usar as APIs, o senhor pode enviar até 30 solicitações por minuto. Exceder esse limite resulta na desativação de seu token de autorização por 5 minutos. Em caso de requisitos especiais, entre em contato com nossa equipe de suporte.

Autorização de acesso à API

Ao consumir uma API, o senhor precisa adicionar a chave de autorização como um valor de cabeçalho de "X-PlanRadar-API-Key". A chave de autorização pode ser obtida gerando Personal Access Tokens e usando-os para autenticar suas solicitações de API.

APIs disponíveis

1. Clique em Settings
2. Clique em Documentação da API
3. Digite sua senha
4. Clique em Confirm
   
5. Selecione o recurso que o senhor deseja mostrar suas APIs
   
6. Será exibida uma lista de todas as APIs relacionadas a esse recurso
   

Atualmente, estamos trabalhando na atualização de todas as nossas APIs para a v2. Recomendamos o uso das APIs v2, se estiverem disponíveis. As APIs V2 são mais rápidas, robustas e mais flexíveis do que as APIs v1.

Exemplo de solicitação de API

Aqui está um exemplo de uso de APIs para chamar detalhes do projeto:

URL DA API:

GET /api/v1/{customer_id}/projects

Corpo da solicitação:

  {
    "data": {
      "attributes": {
        "name": "Your Project Name" (Nome do seu projeto)
      }
    }
  }

Corpo da resposta:

  {
    "data": {
      "id": "aqbqod",
      "type": "projects" (projetos),
      "attributes" (atributos): {
        "id": "aqbqod",
        "name": "Nome do seu projeto",
        "homepage": "",
        "country": nulo,
        "projectnumber": nulo,
        "description": nulo,
        "city": nulo,
        "zipcode": nulo,
        "street": nulo,
        "author-id": "pxpp",
        ...
      }
    }
  }

Conceitos básicos de API

Saiba mais sobre os conceitos fundamentais por trás de nossas APIs. Leia mais em Principais conceitos de API.

Tutoriais de API

Explore os tutoriais passo a passo sobre como usar nossas APIs nas seguintes áreas:

Tutoriais de API para pontos de extremidade do usuário

Tutoriais de API para pontos de extremidade do projeto

Tutoriais de API para Tickets Endpoints

Tutoriais de API para pontos de extremidade de documento

Tutoriais de API para Schedule Endpoints

Registro de alterações da API

Veja as últimas atualizações e alterações em nossas APIs. Leia mais em API Changelog.