Simply CRM Web Service & API-dokumentation

Denne dokumentation beskriver den REST-baserede applikationsprogrammeringsgrænseflade (API) udgivet af Simply CRM . Det er ment som et referencedokument for alle, der bruger vores API'er.

Vi anbefaler, at du gennemgår selvstudiet, før du prøver at læse denne dokumentation.

Alle strukturelle data inklusive respons fra API er repræsenteret som JSON-strenge.

Hver enhed har et specielt formateret ID, der kan bruges til at slå op på enhedens type og posten. Opret er den ene sag, der ikke kræver et ID.

 http: //Simply_url/webservice.php? operation = [operation type] & sessionName = [session Name] & [operation specific parameters]

I øjeblikket understøtter Simply CRM følgende operationer:

  • getchallenge
  • Log på
  • skab
  • hente
  • opdatering
  • slet
  • synkronisere
  • forespørgsel
  • listetyper
  • beskrive
  • Log ud
  • extensionsession

Sessionsnavn

Den nøgle, der bruges til entydigt at identificere den aktuelle session. Disse oplysninger skal sendes til serveren som en del af hver anmodning.

Webtjeneste

Webtjenestens API understøtter den sikkerhedsmodel, der følges i Simply web-brugergrænsefladen.

Loginprocessen bruger et to-trins udfordrings- / reaktionsskema.

Datatyper, der bruges af API'en

Alle svar har nedenstående format. Hvis anmodningen behandles med succes, er formatet:

Hvis der opstår en fejl, mens anmodningen behandles, modtager du følgende svarformat:

 Respons {
succes: boolsk = sand
resultat: Objekt // Resultatobjektet
}
 Respons {
succes: boolsk = falsk
fejl: ErrorObject
}
 ErrorObject {
errorCode: String // Stringrepræsentation af fejltypen
errorMessage: String // Fejlmeddelelse fra api
}

ErrorCode er en strengrepræsentation af fejltypen.

SimplyObject

SimplyObject er et kort, der repræsenterer indholdet af et crm-enhedsbaseret objekt. Alle referencefelter bruger ID-typen, som tildeler et unikt nummer til hvert objekt. Dette felt er til stede for alle objekter, der hentes fra databasen.

ID-format

 objectTypeId 'x' objectId

objectTypeId - Id for objekttypen. Dette genereres entydigt for hver enhed, der understøttes af webtjenestens API og returneres i resultatet af beskriv driften som idPrefix.

objectId - id for objekt i databasen. Dette er et globalt unikt id for objekter fra den givne enhed.

Kort

Et associerende array med nøgleværdipar. Bruges normalt til oprettelsesoperationen.

Tidsstempel

En lang repræsentation af antallet af sekunder siden Unix-epoken.

Operationer

Log på

Login er en totrins proces: Først genererer vi et unikt tokenopkald getChallenge. Og brug derefter dette token og vores unikke adgangsnøgle til at generere et session-id, der fungerer som et godkendelses-id.

Få udfordring

Bruges til at få et udfordringstoken fra serveren.

Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know. Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know. Error 400 (Bad Request)!!1

400. That’s an error.

Your client has issued a malformed or illegal request. That’s all we know.

Dette skal være en POST-anmodning.

URL-format

 http: //Simply_url/webservice.php? operation = extensionsession

CRM-enheder

Det følgende er listen over CRM-enheder, der er eksponeret af API'en.

Navn Beskrivelse
Kalender Kalendermodulet bruges til at styre opgaver, begivenheder og møder.
Leads Leads-modulet bruges til at spore salgsfremstød.
Konti Kontomodulet bruges til at styre enkeltpersoner eller organisationer, der er involveret i din virksomhed.
Kontakter Kontaktmodulet bruges til at administrere personer, der kan være tilknyttet en konto.
Potentialer Potentials-modulet bruges til at styre salgsmuligheder.
Produkter Produktmodulet bruges til at styre de produkter, som din organisation sælger.
Dokumenter Dokumentmodulet bruges til at administrere de uploadede dokumenter og noter.
E-mails E-mail-modulet er en e-mail-klient, der bruges til at administrere dine e-mails.
HelpDesk HelpDesk-modulet bruges til at spore kundeproblemer såsom feedback, problemer osv.
FAQ FAQ-modulet bruges til at styre det ofte stillede spørgsmål fra dine kunder.
Leverandører Leverandørmodulet bruges til at styre producenter og producenter.
Prisbøger PriceBook-modulet bruges til at styre prisfastsættelsen af produkter.
Citater Tilbudsmodulet bruges til at styre tilbud på produkter.
Købsordre PurchaseOrder-modulet bruges til at administrere og behandle indkøbsordrer.
Salgsordre SalesOrder-modulet bruges til at administrere og behandle salgsordrer.
Faktura Fakturamodulet bruges til at oprette fakturarapporter.
Kampagner Kampagnemodulet bruges til at styre marketingkampagner.
Begivenheder Hændelsesmodulet bruges til at styre aktiviteter såsom opkald og møder.
Brugere Brugermodulet bruges til at styre CRM-brugerne.
Grupper Brugergrupper i Simply CRM .
betalingsmiddel Valutamodul lader administratoren definere forskellige valutaer og indstille de forventede konverteringskurser i forhold til basisvalutaen. Disse valutaer kan bruges i beholdningsmodulet til at understøtte multi-valuta.
DocumentFolders DocumentFolders-modulet bruges til at gruppere dokumenter.

Felttyper

Pickliste

Et felt, der kan indeholde en af en liste over værdier, i hvilket tilfælde kortet indeholder to elementer: picklistValues, som er en liste over mulige værdier, og defaultValue, som er standardværdien for picklisten.

Navn Beskrivelse
picklistValues Repræsenterer listen over mulige værdier.
standard værdi Angiver, hvilken værdi der skal bruges som standardværdi for picklisten.
navn Navnet på felttypen.

Reference

Et felt, der viser en relation til et andet objekt. Felttypekortet vil indeholde et andet element kaldet refererer til, hvilket er et array, der indeholder de moduler, som feltet kan pege på.

Navn Beskrivelse
refererer til Et array, der indeholder de moduler, som feltet kan pege på.
navn Navnet på felttypen.

Dato tid

En streng, der repræsenterer dato og klokkeslæt, formatet er baseret på brugerens indstillinger datoformat.

Dato

En streng, der repræsenterer en dato. Felttypekortet indeholder et andet element kaldet format , der angiver det forventede format for feltværdien baseret på brugerens datoformatindstillinger.

Navn Beskrivelse
format Det forventede format for feltværdien.
navn Navnet på felttypen.

Tekst

Et tekstlinje med flere linjer.

Tid

En streng med formatet hh: mm, som er baseret på brugerens tidsformatindstillinger.

Snor

Et tekstfelt med en linje.

Boolsk

Et boolsk felt, der kun kan have værdierne sandt eller falsk .

Heltal

Et ikke-decimalt talfelt.

Ejer

Et felt, der bruges til at definere ejeren af feltet. Dette kan være en gruppe eller en individuel bruger.

Autogenereret

Felter, såsom objektets ID, hvis værdier genereres automatisk af Simply.

E-mail

Et felt, der bruges til at gemme e-mail-id'er.

telefon

Et felt, der bruges til at gemme telefonnumre.

URL

Et felt til lagring af webadresser.

Dobbelt

Et felt til for flydende tal.

Fil

Et felt, der bruges til at tilføje filer til Simply.

Navn Beskrivelse
maxUploadFileSize Den maksimalt tilladte størrelse, der er tilladt for upload af filer.
navn Navnet på felttypen.

Adgangskode

Et felt, der bruges til at gemme adgangskoder.

Decimal

Et felt, der bruges til flydende numre.

Skype

Et felt, der bruges til at gemme Skype-id'er eller telefonnumre.

Multipickliste

Et valglistefelt, hvor flere værdier kan vælges.

Kendte problemer

Synkronisering fungerer ikke på modulet Brugere og ikke-enhedsmoduler som valuta, grupper osv.

Forespørgsel fungerer ikke på ikke-enhedsmoduler som valuta, grupper osv.

Opdateret den 18/11/2020

Var denne artikel til hjælp?

Relaterede Artikler