APIs abertas

Visão geral

O 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.

Acesso e permissões

As APIs abertas estão disponíveis apenas para contas Pro e Enterprise. Leia mais em Pricing and Subscription.

Para usar as APIs abertas, o senhor precisa de um usuário interno com a permissão de usuário 'API Access'. Leia mais em Permissões.

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

Clique em Settings
Clique em Documentação da API
Digite sua senha
Clique em Confirm
Selecione o recurso que o senhor deseja mostrar suas APIs
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"
 }
 }
}

Corpo da resposta:

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