Denne dokumentasjonen beskriver det REST-baserte applikasjonsprogrammeringsgrensesnittet (API) publisert av Simply CRM . Det er ment som et referansedokument for alle som bruker API-ene våre.
Vi anbefaler at du går gjennom veiledningen før du prøver å lese denne dokumentasjonen.
Alle strukturelle data inkludert respons fra API er representert som JSON-strenger.
Hver enhet har en spesielt formatert ID som kan brukes til å slå opp enhetens type og posten. Opprett er den ene saken som ikke krever ID.
http: //Simply_url/webservice.php? operation = [operasjonstype] & sessionName = [ øktnavn ] og [operasjonsspesifikke parametere]
Foreløpig støtter Simply CRM følgende operasjoner:
- getchallenge
- Logg Inn
- skape
- hente
- Oppdater
- slett
- synkronisering
- spørsmål
- listetyper
- beskrive
- Logg ut
- extensionsession
Sessionsnavn
Nøkkelen som brukes til å identifisere den gjeldende økten unikt. Denne informasjonen skal sendes til serveren som en del av hver forespørsel.
nettjeneste
Webtjenestens API støtter sikkerhetsmodellen som følges i Simply web-brukergrensesnittet.
Påloggingsprosessen bruker en to-trinns utfordrings- / responsordning.
Datatyper som brukes av API
Alle svarene vil ha formatet vist nedenfor. Hvis forespørselen behandles vellykket, er formatet:
Hvis det oppstår en feil mens forespørselen behandles, vil du motta følgende svarformat:
Respons {
suksess: boolsk = sann
resultat: Objekt // Resultatobjektet
} Respons {
suksess: boolsk = falsk
feil: ErrorObject
} ErrorObject {
errorCode: String // Stringrepresentasjon av feiltypen
errorMessage: String // Feilmelding fra API-en
}ErrorCode er en strengrepresentasjon av feiltypen.
SimplyObject
SimplyObject er et kart som representerer innholdet i et CRM-enhetsbasert objekt. Alle referansefelt bruker ID-typen, som tildeler hvert objekt et unikt nummer. Dette feltet er tilstede for alle objekter hentet fra databasen.
ID-format
objectTypeId 'x' objectId
objectTypeId - Id for objekttypen. Dette genereres unikt for hver enhet som støttes av webtjenesten API og returneres i resultatet av beskriv operasjonen som idPrefix.
objectId - ID for objektet i databasen. Dette er en globalt unik id for objekter fra den gitte enheten.
Kart
Et assosiativt utvalg av nøkkelverdipar. Vanligvis brukt i skapeoperasjonen.
TimeStamp
En lang representasjon av antall sekunder siden Unix-epoken.
Operasjoner
Logg Inn
Innlogging er en to-trinns prosess: Først genererer vi et unikt token-anrop getChallenge. Og bruk deretter symbolet og vår unike tilgangsnøkkel til å generere en økt-ID som fungerer som en godkjenningsidentifikator.
Få utfordring
Brukes for å få et utfordringstoken fra serveren.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.
Dette må være en POST-forespørsel.
URL-format
http: //Simply_url/webservice.php? operation = extensionsession
CRM-enheter
Det som følger er listen over CRM-enheter eksponert av API.
| Navn | Beskrivelse |
| Kalender | Kalendermodulen brukes til å administrere oppgaver, arrangementer og møter. |
| Leder | Leads-modulen brukes til å spore salgsleder. |
| Kontoer | Kontomodulen brukes til å administrere enkeltpersoner eller organisasjoner som er involvert i virksomheten din. |
| Kontakter | Kontakter-modulen brukes til å administrere personer som kan være tilknyttet en konto. |
| Potensialer | Potensialmodulen brukes til å administrere salgsmuligheter. |
| Produkter | Produktmodulen brukes til å administrere produktene organisasjonen din selger. |
| Dokumenter | Dokumenter-modulen brukes til å administrere opplastede dokumenter og notater. |
| E-post | E-postmodulen er en e-postklient som brukes til å administrere e-postene dine. |
| HelpDesk | HelpDesk-modulen brukes til å spore kundeproblemer som tilbakemelding, problemer osv. |
| FAQ | FAQ-modulen brukes til å håndtere ofte stilte spørsmål fra kundene dine. |
| Leverandører | Leverandørmodulen brukes til å administrere produsenter og produsenter. |
| Prisbøker | PriceBook-modulen brukes til å styre prisingen av produkter. |
| Sitater | Tilbudsmodulen brukes til å administrere tilbud. |
| Bestilling | PurchaseOrder-modulen brukes til å administrere og behandle innkjøpsordrene. |
| Salgsordre | SalesOrder-modulen brukes til å administrere og behandle salgsordrer. |
| Faktura | Fakturamodulen brukes til å lage fakturarapporter. |
| Kampanjer | Kampanjer-modulen brukes til å administrere markedsføringskampanjer. |
| arrangementer | Hendelsesmodulen brukes til å administrere aktiviteter som samtaler og møter. |
| Brukere | Brukermodulen brukes til å administrere CRM-brukerne. |
| Grupper | Brukergrupper i Simply CRM . |
| Valuta | Valutamodulen lar administratoren definere forskjellige valutaer og angi forventede konverteringsfrekvenser med hensyn til basisvalutaen. Disse valutaene kan brukes i Inventory-modulen for å støtte multivaluta. |
| DocumentFolders | DocumentFolders-modulen brukes til å gruppere dokumenter. |
Felttyper
Plukkliste
Et felt som kan holde en av en liste over verdier, i hvilket tilfelle kartet vil inneholde to elementer: picklistValues som er en liste over mulige verdier, og defaultValue som er standardverdien for picklisten.
| Navn | Beskrivelse |
| picklistValues | Representerer listen over mulige verdier. |
| standardverdi | Spesifiserer hvilken verdi som skal brukes som standardverdi for valglisten. |
| Navn | Navnet på felttypen. |
Referanse
Et felt som viser en relasjon til et annet objekt. Felttypekartet vil inneholde et annet element kalt refererer til som er en matrise som inneholder modulene som feltet kan peke på.
| Navn | Beskrivelse |
| refererer til | En matrise som inneholder modulene som feltet kan peke på. |
| Navn | Navnet på felttypen. |
Dato tid
En streng som representerer dato og klokkeslett, formatet er basert på brukerens innstillinger datoformat.
Dato
En streng som representerer en dato. Felttypekartet vil inneholde et annet element kalt format , som spesifiserer det forventede formatet for feltverdien, basert på brukerens datoformatinnstillinger.
| Navn | Beskrivelse |
| format | Det forventede formatet for feltverdien. |
| Navn | Navnet på felttypen. |
Tekst
Et flerlinjet tekstfelt.
Tid
En streng med formatet hh: mm, som er basert på brukerens tidsformatinnstillinger.
String
Et tekstfelt med en linje.
Boolsk
Et boolsk felt som bare kan ha verdiene sanne eller falske .
Heltall
Et felt som ikke er desimaltall.
Eieren
Et felt som brukes til å definere eieren av feltet. Dette kan være en gruppe eller en individuell bruker.
Autogenerert
Felter, for eksempel objektets ID, hvis verdier genereres automatisk av Simply.
E-post
Et felt som brukes til å lagre e-post-ID-er.
Telefon
Et felt som brukes til å lagre telefonnumre.
URL
Et felt for lagring av nettadresser.
Dobbelt
Et felt for for flytende tall.
Fil
Et felt som brukes til å legge til filer i Simply.
| Navn | Beskrivelse |
| maxUploadFileSize | Maksimal tillatt størrelse for opplasting av filer. |
| Navn | Navnet på felttypen. |
Passord
Et felt som brukes til å lagre passord.
Desimal
Et felt som brukes for flytende punktum.
Skype
Et felt som brukes til å lagre Skype-ID-er eller telefonnumre.
Flervalg
Et valglistefelt der flere verdier kan velges.
Kjente problemer
Synkronisering fungerer ikke på modulene Brukere og ikke-enhetsmoduler som valuta, grupper osv.
Spørring fungerer ikke på ikke-enhetsmoduler som valuta, grupper osv.
