PlanningPME API

Detta dokument informerar dig om:

Definition och roll: vad är ett API?

Ett API är ett gränssnitt för applikationsprogrammering. Låt oss förklara var och en av dessa termer för att bättre förstå dem:

  • - "App": En app är en tjänst som är tillgänglig via ett mänskligt program eller ett datorprogram.
    Exempel: Facebook är en app för ett socialt nätverk, Spotify är en app för ljudstreaming, PlanningPME är en planeringsapp.
  • - "Programmering": ett program är en uppsättning datorfunktioner skriven av en utvecklare som utför uppgifter i hens ställe.
    Exempel: Om jag vill förvandla postadresser till geografiska koordinater kan jag göra det för hand eller så kan jag skriva ett program som gör det åt mig.
  • - "Gränssnitt": ett gränssnitt skapar kopplingen mellan två saker, i vårt fall mellan en applikation och de program som använder den. Den definierar vad programmet kan begära från applikationen, sänder programförfrågningar till applikationen och applikationssvar till programmet.


Precis som en fjärrkontroll är gränssnittet som används av en tittare för att programmera sin TV, är ett API det gränssnitt som används av en programmerare för att interagera med en applikation

PlanningPME API är därför gränssnittet i PlanningPME-applikationen, det spelar en viktig roll.
Som en obligatorisk knutpunkt kan den identifiera åtkomster, säkra överföringar, kontrollera volymen på förfrågningar, etc. ...

Volymer: vad är gränserna för anrop till PlanningPME API?

Varje installation av ett PlanningPME API är tillgängligt via en säker nyckel, kallad AppKey, som autentiserar ett program (eller programuppsättning) till API:t.

Som standard har samma AppKey en maximal volym på 2 000 förfrågningar per timme.
Utöver denna gräns kommer ägaren till nyckeln att meddelas om överskridandet och hens plan justeras enligt följande avgiftsschema.

BasicMilliMikroNanoPlus
2 000 förfrågningar per timme3 000 förfrågningar per timme5 000 förfrågningar per timme8 000 förfrågningar per timme+ 10 000 förfrågningar per timme
Gratis15 € / månad30 € / månad50 € / månadKontakta oss

Exempel: mitt program skickar 4 500 förfrågningar på mindre än en timme med samma AppKey och jag meddelas via e-post att min timkvot har nått "Micro" -nivån, och att jag kommer att debiteras 50 € i slutet av månaden

För mer än 10 000 förfrågningar per timme krävs en överenskommelse på förhand.
Alla nycklar som är bortom den maximala godkända kvoten för användning kommer att stängas av omedelbart.

Innebörd: vad är skillnaderna mellan standard-API och anpassat API?

PlanningPME API har två typer av operationer.

Standard APIlåter dig göra alla grundläggandeenhetsoperationer i PlanningPME-applikationen.

Exempel: lägg till/ändra/radera en händelse, uppdatera en kund/ett projekt/en resurs, ändra rättighet för en grupp, ändra ett alternativ etc....

Alla dessa åtgärder beskrivs i interaktiv dokumentation .

Med anpassad API kan massoperationer utföras i PlanningPME-applikationen, och man konfigurerar dessa operationer inom integrationsmallar.

Exempel: Jag skickar den uppdaterade informationen från mina 25 000 kunder till API:t, i en enda begäran och i ett fördefinierat och anpassat format, API:t ansvarar för att uppdatera kunder som redan är i databasen, lägga till nya eller till och med ta bort gamla kunder.

Dessa operationer, även kallade integrationsoperationer ("integration"-metod i API), definieras i integrationsmallar.

Det rekommenderas starkt att du använder det anpassade API:t för att implementera all massynkronisering (till exempel av typ kund/resurs/projekt) för att inte överskrida användningsgränser för din nyckel. Synkronisering med det anpassade API:t kostar endast 1 begäran, oavsett antalet objekt som uppdateras i den här förfrågan.

Se dokumentationen för anpassad integrations-API för mer information.