Simply CRM Web Service Tutorial

Bare gir et enkelt, kraftig og sikkert applikasjonsprogrammeringsgrensesnitt (API) for å jobbe med enhetene som er lagret i. For å bruke dette dokumentet, bør du ha en grunnleggende kjennskap til programvareutvikling, webtjenester og Simply CRM .

Nettjenesten gir en enklere måte å integrere enkelt med andre programvaresystemer.

API-samtaleegenskapene

REST – API er REST-basert, noe som betyr at all kommunikasjon mellom klienten og serveren kan skje via HTTP i form av GET- eller POST-forespørsler.

JSON – JSON brukes til å kode svaret og forespørselen.

Forespørsler og svar – Kundesøknaden din forbereder og sender en tjenesteforespørsel til API. API behandler forespørselen og returnerer et svar, og deretter håndterer klientprogrammet svaret.

Forpliktet automatisk – Hver operasjon som skriver til et Simply-objekt blir begått automatisk. Dette er analogt med AUTOCOMMIT-innstillingen i SQL.

API-svaret

Svarobjekt

Alle svarene vil ha ett av følgende to formater.

Hvis forespørselen behandles vellykket:

 <code> Svar { 
suksess: boolsk = sann
resultat: Objekt // Operasjonsresultatobjektet
}
</code>

Hvis det oppstår en feil under behandlingen av forespørselen:

 <code> Svar { 
suksess: boolsk = falsk
feil: ErrorObject
}
</code>

Feilobjekt

 <code> ErrorObject { 
errorCode: String // Stringrepresentasjon av feiltypen
errorMessage: String // Feilmelding fra API-en.
}
</code>

errorCode er en strengrepresentasjon av feiltypen.

Feilhåndtering

Svaret for enhver webtjenesteforespørsel er et JSON-objekt. Objektet har en feltsuksess som vil ha verdien sann hvis operasjonen var en suksess og ellers falsk. Hvis suksess er falsk, vil responsobjektet inneholde en feltfeil som vil inneholde JSON-objektet. Feilobjektet vil inneholde to felt errorType, en enkelt beskrivelse av feilen, og errorMsg, en streng som inneholder en beskrivelse av feilen.

Eksempelkoden er skrevet i Php og har to avhengigheter Zend JSON-biblioteket og Http_Client.

Kravene til å kjøre eksempler er gitt i opplæringen

  1. En installasjon av Simply with the web service;
  2. Php for å kjøre eksempelkoden;
  3. HTTP_Client som kan installeres ved å utføre en pear install HTTP_Client ;
  4. Zend JSON, som du må laste ned det minimale zend-rammeverket for .

Logger inn

API-et bruker ikke passordet for pålogginger. I stedet gir Simply en unik tilgangsnøkkel for hver bruker. For å få brukernøkkelen, gå til Mine preferanser-panelet til en bestemt bruker. Der finner du feltet Access Key.

Hver pålogging starter en klientsession med serveren, autentiserer brukeren og returnerer en sessionId som skal brukes til all etterfølgende kommunikasjon med serveren.

Innlogging er en totrinnsprosess. I det første trinnet får klienten utfordringstoken fra serveren, som brukes sammen med brukerens tilgangsnøkkel for å logge på.

GetChallenge

Få et utfordringstoken fra serveren. Dette må være en GET-forespørsel.

URL-format

 <code> Type forespørsel: GET 

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

& brukernavn = [brukernavn]
</code>

GetChallenge eksempel

For å få utfordringstokenet, må du utføre følgende kode.

 <code> // f.eks // urlbane til Simply / webservice.php som http: //Simply_url/webservice.php 
$ endpointUrl = "http: //localhost/ws/webservice.php";
// brukernavn til brukeren som skal logge inn.
$ userName = "admin";

$ httpc = ny HTTP_CLIENT ();
// getchallenge-forespørsel må være en GET-forespørsel.
$ httpc-> get ("$ endpointUrl? operation = getchallenge & username = $ userName"); $ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// sjekk om den forespurte operasjonen var vellykket eller ikke.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('getchallenge failed:'. $ jsonResponse ['error'] ['errorMsg']);

// operasjonen var vellykket få token fra svaret. $ challengeToken = $ jsonResponse ['resultat'] ['token'];
</code>

GetChallenge-resultat

Et objekt som representerer svarresultatet av en getchallenge-operasjon.

 <code> GetChallengeResult { 
token: String // Challenge token fra serveren.
serverTime: TimeStamp // Gjeldende servertid.
expireTime: TimeStamp // Tiden da tokenet utløper.
}
</code>

Nå som du har utfordringstokenet, kan du fortsette med påloggingen. Tilgangsnøkkelfeltet i påloggingsoperasjonen er md5-kontrollsummen av sammenkoblingen av utfordringstokenet og brukerens egen tilgangsnøkkel. Innloggingsoperasjonen, i motsetning til getchallenge, er en postforespørsel.

Logg Inn

Logg deg på serveren ved hjelp av utfordringstokenet som ble oppnådd i getchallenge-operasjonen.

URL-format

 <code> Forespørselstype: POST 
http: //Simply_url/webservice.php? operation = login

& brukernavn = [brukernavn]
& accessKey = [accessKey]
</code>

For accessKey, opprett en md5-streng etter sammenkobling av brukeradgangsnøkkel fra siden Min preferanse og utfordringstoken hentet fra getchallenge-resultatet.

Innloggingseksempel

 <code> // f.eks 
// tilgangsnøkkel til brukeradministratoren, funnet på siden med preferanser.
$ userAccessKey = 'dsf923rksdf3';

// opprett md5-streng som sammenkobler brukertilgangsnøkkel fra min preferanseside
// og utfordringstoken hentet fra få utfordringsresultat.
$ generatedKey = md5 ($ challengeToken. $ userAccessKey);
// påloggingsforespørsel må være POST-forespørsel.
$ httpc-> post ("$ endpointUrl",
array ('operation' => 'login', 'username' => $ userName,
'accessKey' => $ generatedKey), sant);
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('login failed:'. $ jsonResponse ['error'] ['errorMsg']);

// pålogging vellykket pakke ut sessionId og userId fra LoginResult til den kan brukes til videre samtaler.
$ sessionId = $ jsonResponse ['resultat'] ['sessionName'];
$ userId = $ jsonResponse ['resultat'] ['userId'];

</code>

Økten ID brukes til å identifisere den gjeldende økten og vil være en vanlig parameter i alle påfølgende forespørsler.

Påloggingsresultat

Et objekt som representerer svarresultatet av en påloggingsoperasjon.

Få informasjon

API-en gir to operasjoner for å få informasjon om de tilgjengelige Simply-objektene.

Den første er listetyper, som gir en liste over tilgjengelige moduler. Denne listen inneholder bare moduler den innloggede brukeren har tilgang til.

Listetyper

Liste opp navnene på alle Simply-objektene som er tilgjengelige via API.

URL-format

 <code> Type forespørsel: GET 

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

& øktnavn = [økt-ID]
</code>

Returnerer et kart som inneholder nøkkeltypene, med verdien som en liste over navnene på Simply.

Eksempel på listetyper

 <code> // listtypes-forespørsel må være GET-forespørsel. 
$ httpc-> get ("$ endpointUrl? sessionName = $ sessionId & operation = listetypes");
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('list types failed:'. $ jsonResponse ['error'] ['errorMsg']);
// Få listen over alle modulene som er tilgjengelige.
$ modules = $ jsonResponse ['result'] ['types'];
</code>

Den andre operasjonen er beskrevet, og den gir detaljert typeinformasjon om et Simply-objekt.

Beskrive

Få typen informasjon om et gitt Simply-objekt.

URL-format

 <code> Type forespørsel: GET 

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

& øktnavn = [økt-ID]
& elementType = [elementType]
</code>

Beskriv eksemplet

 <code> // f.eks 
// Bare objektnavn som må beskrives eller hvis informasjon blir bedt om.
$ moduleName = 'Kontakter';

// bruk sessionId opprettet på innloggingstidspunktet.
$ params = "sessionName = $ sessionId & operation = beskriv & elementType = $ moduleName";
// beskriv forespørsel må være GET-forespørsel.
$ httpc-> get ("$ endpointUrl? $ params");
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('beskriv objekt mislyktes:'. $ jsonResponse ['error'] ['errorMsg']);
// få beskrive resultatobjekt. $ beskrivelse = $ jsonResponse ['resultat'];

</code>

Beskrivelsen består av følgende felt:

Navn Beskrivelse
Merkelapp Etiketten som brukes til navnet på modulen.
Navn Navnet på modulen.
Kan skapes En boolsk verdi som angir om objektet kan opprettes.
Kan oppdateres En boolsk verdi som angir om objektet kan oppdateres.
Slettbar En boolsk verdi som angir om objektet kan slettes.
Gjenopprettelig En boolsk verdi som angir om objektet kan hentes.
Enger En matrise som inneholder feltnavn og typeinformasjon.

Hvert element i feltmatrisen beskriver et bestemt felt i objektet.

Typefeltet er spesielt viktig da det beskriver hvilken type felt som er. Dette er et kart som vil inneholde minst ett element som heter navn, som spesifiserer navnet på typen.

Navn Beskrivelse
String Et tekstfelt med en linje.
Tekst Et flerlinjet tekstfelt.
Heltall Et flerlinjet tekstfelt.
Dobbelt Et felt for for flytende tall.
Boolsk Et boolsk felt som kan ha verdiene sanne eller falske.
Tid En streng i formatet hh: mm, som er basert på brukerens tidsformatinnstillinger.
Dato En streng som representerer en dato, vil typekartet inneholde et annet element kalt format som er formatet som verdien av dette feltet forventes i, basert på brukerens innstillingsdatoformat.
Dato tid En streng som representerer dato og klokkeslett, som er basert på brukerens innstillinger for datoformat.
Autogenerert Feltene som verdiene genereres automatisk av Simply. Dette er vanligvis et objekts ID-felt.
Referanse Et felt som viser en relasjon til et annet objekt. Typekartet vil inneholde et annet element kalt referer til, som er en matrise som inneholder modulene som feltet kan peke på.
Plukkliste Et felt som kan inneholde en av en liste over verdier. Kartet inneholder to elementer, picklistValues, som er en liste over mulige verdier, og defaultValue, som er standardverdien for picklisten.
Flervalg Et valglistefelt der flere verdier kan velges.
Telefon Et felt som brukes til å lagre telefonnumre.
E-post Et felt som brukes til å lagre e-post-ID-er.
URL Et felt som brukes til å lagre nettadresser.
Skype Et felt som brukes til å lagre Skype-ID-er eller telefonnumre.
Passord Et felt som brukes til å lagre passord.
Eieren Et felt som definerer eieren av feltet, som kan være en gruppe eller en individuell bruker.

Beskriv resultatet

 <code> DescribeResult { 
label: String // label of the module.
name: String // name of the module, as one provided in request.
kan skapes: Boolsk // true hvis den påloggede brukeren har tillatelse, opprette poster av typen og falsk ellers.
kan oppdateres: Boolsk // true hvis den påloggede brukeren får lov til å oppdatere poster av typen og falsk ellers.
slettbar: Boolsk // true hvis den påloggede brukeren får slette poster av typen og falske ellers.
retrieveable: Boolean // true hvis den påloggede brukeren har tillatelse til retrieveable poster av typen og false ellers.
felt: Array // matrise av typen Felt.
}
</code>

Felt

 <code> Felt { 

<pre class = "_ fck_mw_lspace"> navn: String // navn på feltet.


label: String // label of the field.
obligatorisk: Boolsk // sant hvis behovene skal tilføres verdi mens du gjør en opprettingsforespørsel og falsk ellers.
type: FieldType // en forekomst av FieldType.
standard: anyType // standardverdien for feltet.
nillable: Boolsk // true hvis null kan gi en verdi for feltet og false ellers.
redigerbar: Boolsk // sant hvis feltet kan få en verdi mens du oppretter eller oppdaterer operasjonen.
}
</code>

Feltype

Error 400 (Bad Request)!!1

400. That’s an error.

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

Eksempel 3

Opprett en kontakt og knytt den til en ny konto.

 <code> // f.eks. 3 
<p> // Opprett en kontakt og knytt til en ny konto.
</p> <p> // fyll ut detaljene i kontoene. userId er hentet fra loginResult.
$ accountData = array ('accountname' => 'Simply', 'assigned_user_id' => $ userId);
// koder objektet i JSON-format for å kommunisere med serveren.
$ objectJson = Zend_JSON :: kode ($ accountData);
// navn på modulen som oppføringen må opprettes for.
$ moduleName = 'Kontoer';
</p> <p> // sessionId er hentet fra loginResult.
$ params = array ("sessionName" => $ sessionId, "operation" => 'create',
</p>
<pre class = "_ fck_mw_lspace"> "element" => $ objectJson, "elementType" => $ moduleName);

// Opprett må være POST-forespørsel. $ httpc-> post (“$ endpointUrl”, $ params, true); $ respons = $ httpc-> currentResponse (); // dekode json-kodesvaret fra serveren. $ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)

// håndtere feilsaken.
die ('create failed:'. $ jsonResponse ['error'] ['errorMsg']);

$ konto = $ jsonResponse ['resultat']; $ accountId = $ konto ['id'];

$ contactData = array ('lastname' => 'Valiant', 'assigned_user_id' => $ userId, 'account_id' => $ accountId);

// koder objektet i JSON-format for å kommunisere med serveren. $ objectJson = Zend_JSON :: kode ($ contactData); // navn på modulen som oppføringen må opprettes for. $ moduleName = 'Kontakter';

// sessionId er hentet fra loginResult.
$ params = array (“sessionName” => $ sessionId, “operation” => 'create',

"element" => $ objectJson, "elementType" => $ moduleName);

// Opprett må være POST-forespørsel. $ httpc-> post (“$ endpointUrl”, $ params, true); $ respons = $ httpc-> currentResponse (); // dekode json-kodesvaret fra serveren. $ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)

// håndtere feilsaken.
die ('create failed:'. $ jsonResponse ['error'] ['errorMsg']);
$ savedObject = $ jsonResponse ['resultat']; $ id = $ savedObject ['id'];

</code> </pre>

CreateResult

Et kart som representerer innholdet i et CRM-enhetsbasert objekt. Alle referansefelt er representert ved hjelp av ID- type. En nøkkel kalt ID av typen Id representerer objektets unike ID. Dette feltet er tilstede for ethvert objekt hentet fra databasen.

Hente

Hent en eksisterende oppføring fra serveren.

URL-format

 <code> Type forespørsel: GET 

http: //Simply_url/webservice.php? operation = hent
& session_name = [økt-id]
& id = [objekt-id

</code>

Hent eksempel

For å hente et objekt ved hjelp av ID-en, bruk hentingsoperasjonen. Du kan hente kontakten som ble opprettet i opprettingseksemplet.

 <code> // sessionId er hentet fra loginResult. 
$ params = "sessionName = $ sessionId & operation = hente & id = $ id";
// Hent må være GET-forespørsel.
$ httpc-> get ("$ endpointUrl? $ params");
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);
// operasjonen var vellykket få token fra svaret.

if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('retrieve failed:'. $ jsonResponse ['error'] ['errorMsg']);

$ retrievedObject = $ jsonResponse ['resultat'];
</code>

RetrieveResult

Error 400 (Bad Request)!!1

400. That’s an error.

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

Eksempel 2

Spesifiser kolonnene som skal hentes for hver post.

 <code> // spørring for å velge data fra serveren. 
$ query = "velg etternavn, fornavn, konto_id, tildelt_bruker_id fra Kontakter der etternavn = 'Valiant';";
// urlencode til som den sendes over http.
$ queryParam = urlencode ($ spørring);
// sessionId er hentet fra innloggingsresultatet.
$ params = "sessionName = $ sessionId & operation = spørring & spørring = $ queryParam";
// spørring må være GET Request.
$ httpc-> get ("$ endpointUrl? $ params");
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('spørringen mislyktes:'. $ jsonResponse ['errorMsg']);

// Array of SimplyObjects
$ retrievedObjects = $ jsonResponse ['resultat'];
</code>

Dette returnerer en matrise som inneholder matriser som representerer feltene til hvert objekt som samsvarte med spørringen.

QueryResult

QueryResult er en rekke SimplyObjects.

SimplyObject

Et kart som representerer innholdet i et grovhetsbasert objekt. Alle referansefelt er representert ved hjelp av Id- type. En nøkkel kalt ID av typen Id representerer objektets unike ID. Dette feltet er tilstede for ethvert objekt hentet fra databasen.

Spørringsformat

 <code> velg * | <kolonneliste> | <count (*)> 
fra <objekt> [der <betingelser>]
[rekkefølge etter <kolonneliste>] [begrense [<m>,] <n>];

</code>

Kolonnelisten i rekkefølge etter ledd kan maksimalt ha to kolonnenavn.

Navn Beskrivelse
kolonneliste En kommaseparert liste over feltnavn.
gjenstand Typenavnet på objektet.
betingede Betingede operasjoner eller i ledd eller lignende ledd atskilt med 'og' eller 'eller' operasjoner disse behandles fra venstre til høyre. Det er ingen gruppering, det vil si brakettoperatører.
betingede operatører <,>, <=,> =, =,! =
i klausuler <kolonnenavn> i (<verdiliste>).
som klausuler <kolonnenavn> i (<verdimønster>).
verdiliste En kommaseparert liste over verdier.
m, n Heltallverdiene for å spesifisere henholdsvis forskyvning og grense.

Synkroniser

Sync vil returnere et SyncResult-objekt som inneholder detaljene i endringene etter modifiedTime.

URL-format

 <code> Type forespørsel: GET 

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

& øktnavn = [økt-ID]
& modifiedTime = [tidsstempel]
& elementType = [elementType]
</code>

elementType – Dette er en valgfri parameter. Hvis spesifisert, returneres bare endringene for den modulen etter gitt tid. Ellers returneres endringene i alle brukertilgjengelige moduler etter gitt tid.

TimeStamp – En lang representasjon av antall sekunder siden Unix-epoken.

Eksempel 1

Opprett en konto og fang den i sync API.

Svaret inneholder kontoen som ble opprettet.

Eksempel 2

Opprett en konto og en kontakt, bruk kun synkroniserings-API for kontomodulen, bare endringer i kontomodulen returneres.

 <code> // tid etter som alle endringene på serveren er nødvendige. 
$ stime = tid ();
// Lag noen data nå, slik at de fanges opp av synkroniserings-api-svaret.

// fyll ut detaljene i Accounts.userId er hentet fra loginResult.
$ accountData = array ('accountname' => 'Simply', 'assigned_user_id' => $ userId);
// koder objektet i JSON-format for å kommunisere med serveren.
$ objectJson = Zend_JSON :: kode ($ accountData);
// navn på modulen som oppføringen må opprettes for.
$ moduleName = 'Kontoer';

// sessionId er hentet fra loginResult.
$ params = array ("sessionName" => $ sessionId, "operation" => 'create',
"element" => $ objectJson, "elementType" => $ moduleName);
// Opprett må være POST-forespørsel.
$ httpc-> post ("$ endpointUrl", $ params, true);
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('create failed:'. $ jsonResponse ['error'] ['errorMsg']);
$ createResult = $ jsonResponse ['resultat'];

// Opprett en kontakt.
// fyll ut detaljene for kontaktene. brukerId er hentet fra loginResult.
$ contactData = array ('lastname' => 'Valiant', 'assigned_user_id' => $ userId);
// koder objektet i JSON-format for å kommunisere med serveren.
$ objectJson = Zend_JSON :: kode ($ contactData);
// navn på modulen som oppføringen må opprettes for.
$ moduleName = 'Kontakter';

// sessionId er hentet fra loginResult.
$ params = array ("sessionName" => $ sessionId, "operation" => 'create',
"element" => $ objectJson, "elementType" => $ moduleName);
// Opprett må være POST-forespørsel.
httpc-> post ("$ endpointUrl", $ params, true);
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('create failed:'. $ jsonResponse ['error'] ['errorMsg']);
$ savedObject = $ jsonResponse ['resultat'];
$ id = $ savedObject ['id'];

$ params = "operation = sync & modifiedTime = $ stime & sessionName = $ sessionId";

// sync må være GET Request.
$ httpc-> get ("$ endpointUrl? $ params");
$ respons = $ httpc-> currentResponse ();
// dekode json-kodesvaret fra serveren.
$ jsonResponse = Zend_JSON :: dekode ($ respons ['body']);

// operasjonen var vellykket få token fra svaret.
if ($ jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('spørringen mislyktes:'. $ jsonResponse ['errorMsg']);
// Array of SimplyObjects
$ retrievedObjects = $ jsonResponse ['resultat'];

</code>

SyncResult

Et objekt som representerer responsen til en synkroniseringsoperasjon.

 <code> SyncResult { 
oppdatert: [Objekt] // Liste over objekter opprettet eller endret.
slettet: [Id] // Liste over * Id * for objekter slettet.
lastModifiedTime: Timstamp // tidspunktet for den siste endringen. som kan brukes i neste samtale til Sync api for å få alle de siste endringene som klienten ikke har fått.
}
</code>

Logger ut

Logg ut

Logg ut fra webservicesesjonen, som etterlater webservicesesjonen ugyldig for videre bruk.

URL-format

 <code> Type forespørsel: GET 

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

& øktnavn = [økt-ID]
</code>

Eksempel

Utvide Simply-webklienten ved hjelp av nettjeneste

Forleng økten

Utvider den nåværende Simply-webklientøkten til webtjenesten og returnerer en ID for webserviceøkten. Når du arbeider innenfra Simply-webklienten, kan brukeren bruke den gjeldende autentiserte økten på nytt i stedet for å logge på Simply igjen for å få tilgang til nettjenesten.

Merk: Hvis brukeren utvider en økt, vil økten bli bundet sammen, så ved å logge ut fra en (webtjenesten eller webklienten) vil brukeren også logge ut av den andre. For at utvidelsesøkten skal fungere, må informasjonskapsler være aktivert i klientens nettleser.

URL-format

 <code> Forespørselstype: POST 

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

</code>

Eksempel

 <kode> 
</code>

Dette eksemplet er skrevet er Javascript, ettersom Extend Session bare er gyldig fra Simply webklienten.

Krav for å kjøre eksemplet

  • JQUERY-bibliotek – for å gjøre ajax http-forespørselen.
  • JSON-bibliotek – json2.js-fil tilgjengelig med Simply på json.org.

Eksempel 1

 <kode> 
// operasjonsparametere.
var params = "operation = extensionsession";
// sluttpunkt for tjenestene.
var endPointUrl = "http: //Simply_url/webservice.php";

// extensjon er postforespørsel, påkall jquery http postforespørsel.
$ .post (endPointUrl, params, function (result) {
// dekode json-kodesvaret fra serveren.
var jsonResponse = json.parse (resultat);

// operasjonen var vellykket få token fra svaret.
hvis (jsonResponse ['suksess'] == usann)
// håndtere feilsaken.
die ('login failed:' + jsonResponse ['error'] ['errorMsg']);

// pålogging vellykket pakke ut sessionId og userId fra LoginResult slik at den kan brukes til videre samtaler.
var sessionId = jsonResponse ['resultat'] ['sessionName'];
var userId = jsonResponse ['result'] ['userId'];
});
</code>

Oppdatert på 24/09/2020

Var denne artikkelen til hjelp?

Relaterte Artikler