PlanningPME API

Uma API é uma Interface de Programação de Aplicação. Vamos explicar cada um destes termos para melhor compreender:

• -  "Aplicação": Uma aplicação é um serviço acessível por um programa humano ou de computador.
  Ex: Facebook é uma aplicação de rede social, Spotify é uma aplicação de streaming de áudio, PlanningPME uma aplicação de planeamento.
• -  "Programação": um programa é um conjunto de funções informáticas escritas por um programador que executa tarefas no seu lugar.
  Ex: Se eu quiser transformar endereços postais em coordenadas geográficas, posso fazê-lo à mão, ou posso escrever um programa para o fazer por mim.
• -  "Interface": uma interface faz a ligação entre duas coisas, no nosso caso entre uma aplicação e os programas que a utilizam. Define o que o programa pode pedir à aplicação, transmite os pedidos de programa à aplicação, e as respostas da aplicação ao programa.

Tal como um controlo remoto é a interface utilizada por um espectador para programar a sua televisão, uma API é a interface utilizada por um programador para interagir com uma aplicação.

A API do PlanningPME é, portanto, a interface da aplicação PlanningPME, desempenha um papel importante.
Como ponto de passagem obrigatório, é capaz de identificar acessos, assegurar transmissões, controlar o volume de pedidos, etc ...

Cada instalação de um PlanningPME API tem acesso através de uma chave segura, chamada AppKey, que autentica um programa (ou conjunto de programas) para o API.

Por defeito, o mesmo AppKey tem um volume máximo de pedido de 2.000 por hora.
Para além deste limite, o proprietário da chave será notificado da ultrapassagem, e o seu plano ajustado de acordo com o seguinte calendário de taxas.

Básico	Milli	Micro	Nano	Mais
2 000 pedidos por hora	3 000 pedidos por hora	5 000 pedidos por hora	8 000 pedidos por hora	+ 10 000 pedidos por hora
Grátis	15 € / mês	30 € / mês	50 € / mês	Consultar-nos

Ex: o meu programa faz 4.500 pedidos em menos de uma hora com o mesmo AppKey, sou notificado por e-mail que a minha quota horária chegou à fatia "Micro", e que me serão cobrados 30 euros no final do mês.

Acima de 10.000 pedidos por hora, é obrigatório um acordo prévio.
Qualquer chave que esteja fora desta quota máxima de utilização autorizada será imediatamente desligada.

O API do PlanningPME tem dois tipos de operações.

O API padrão permite fazer todas as operações básicas unit operations na aplicação PlanningPME.

Ex: adicionar / modificar / apagar um evento, actualizar um cliente / projecto / recurso, modificar os direitos de um grupo, alterar uma opção, etc. ...

Todas estas operações estão descritas em interactive documentation.

A API API personalizada permite operações de massa a serem realizadas na aplicação PlanningPME, e estas operações são configuradas dentro de modelos de integração.

Ex: envio a informação actualizada dos meus 25.000 clientes à API, num único pedido e num formato pré-definido e personalizado, a API é responsável pela actualização dos clientes já em base, pela adição de novos clientes, ou mesmo pela remoção de clientes obsoletos.

Estas operações, também chamadas operações de integração (método "integração" da API), são definidas dentro de modelos de integração.

É fortemente recomendada a utilização da API personalizada para implementar qualquer sincronização em massa (tipo cliente / recurso / projecto por exemplo), de modo a não exceder usage limits of your key. A sincronização utilizando a API personalizada custa apenas 1 pedido, independentemente do número de itens actualizados nesta consulta.

Ver a documentação do custom integration API para mais detalhes.