PlanningPME API

Dit document informeert u over:

Definitie en rol: wat is een API?

Een API is een Application Programming Interface. Laten we elk van deze termen uitleggen voor een beter begrip:

  • - "Toepassing": een toepassing is een service die toegankelijk is voor een mens of een computerprogramma.
    Voorbeeld: Facebook is een toepassing voor een sociaal netwerk, Spotify is een toepassing voor audiostreaming, PlanningPME een planningstoepassing.
  • - "Programmering": een programma is een set computerfuncties geschreven door een ontwikkelaar die taken in zijn plaats uitvoert.
    Voorbeeld: als ik postadressen in geografische coördinaten wil omzetten, kan ik dit met de hand doen, of ik kan schrijf een programma om het voor mij te doen.
  • - "Interface": een interface legt de verbinding tussen twee dingen, in ons geval tussen een toepassing en de programma's die deze gebruiken. Het definieert wat het programma kan aanvragen bij de applicatie, verzendt programmavragen naar de applicatie en applicatiereacties naar het programma.


Net zoals een afstandsbediening de interface is die een kijker gebruikt om zijn televisie te programmeren, is een API de interface die een programmeur gebruikt om met een applicatie te communiceren.

De PlanningPME API is daarom de interface van de PlanningPME-applicatie en speelt een belangrijke rol.
Als een verplicht kruispunt is het in staat om toegangen te identificeren, transmissies te beveiligen, het volume van verzoeken te controleren, enz …

Volumetrie: wat zijn de limieten voor aanroepen van de PlanningPME API?

Elke installatie van een PlanningPME API is toegankelijk via een beveiligde sleutel, AppKey genaamd, die een programma (of een reeks programma's) bij de API authenticeert.

Standaard heeft dezelfde AppKey een maximaal verzoekvolume van 2.000 per uur.
Voorbij deze limiet wordt de eigenaar van de sleutel op de hoogte gebracht van de overschrijding en wordt zijn plan aangepast volgens het volgende tariefschema.

BasicMilliMicroNanoPlus
2 000 aanvragen per uur3 000 aanvragen per uur5 000 aanvragen per uur8 000 aanvragen per uur+ 10 000 aanvragen per uur
Gratis15 € / maand30 € / maand50 € / maandOns om advies vragen

Bijv: mijn programma doet 4.500 verzoeken in minder dan een uur met dezelfde AppKey, ik krijg per e-mail bericht dat mijn uurquotum het segment "Micro" heeft bereikt en dat ik aan het einde van de maand 50€ in rekening zal worden gebracht.

Boven 10.000 aanvragen per uur is een voorafgaande overeenkomst verplicht.
Elke sleutel die buiten dit maximale toegestane gebruiksquotum valt, wordt onmiddellijk uitgeschakeld.

Roeping: wat zijn de verschillen tussen de standaard API en de aangepaste API?

De PlanningPME API heeft twee soorten bewerkingen.

Met de standaard-API kunt u alle standaard eenheidsbewerkingen uitvoeren op de PlanningPME-toepassing.

Vb: een gebeurtenis toevoegen / wijzigen / verwijderen, een client / project / resource bijwerken, de rechten van een groep wijzigen, een optie wijzigen enz …

Al deze bewerkingen worden beschreven in de interactieve documentatie .

Aangepaste API maakt het mogelijk massabewerkingen uit te voeren op de PlanningPME-toepassing, en één stelt deze bewerkingen in in integratiesjablonen.

Bijv: Ik stuur de bijgewerkte informatie van mijn 25.000 klanten naar de API, in een enkel verzoek en in een vooraf gedefinieerde en aangepaste indeling, is de API verantwoordelijk voor het bijwerken van klanten die al in de basis zijn, nieuwe toevoegen of zelfs verouderde klanten verwijderen.

Deze bewerkingen, ook wel integratiebewerkingen genoemd ("integratiemethode" van de API), worden gedefinieerd in integratiesjablonen.

Het wordt ten zeerste aanbevolen om de aangepaste API te gebruiken om massasynchronisatie te implementeren (type client / resource / project bijvoorbeeld), om gebruikslimieten van uw sleutel. Synchronisatie met de aangepaste API kost slechts 1 verzoek, ongeacht het aantal items dat in deze query is bijgewerkt.

Raadpleeg de documentatie van de aangepaste integratie-API < / a> voor meer informatie.