La oss bruke Qypher på ditt eget nettsted
Avhengig av enheten din må du kanskje trykke i stedet for å klikke.
For øyeblikket publiseres programmer skrevet i PHP
* php-versjonen krever Ver.7.4 eller høyere, Ver.8.3 eller høyere anbefales.
Sjekk om følgende er mulig før du implementerer Qypher
Må kunne svare via https-tilgang (http:// er ikke tillatt)
Qypher API krypterer kommunikasjon internt, men for ekstra sikkerhet tilbys den kun i miljøer som støtter https-kommunikasjon.
Qypher API bruker OpenSSL-krypteringsbiblioteket.
Må kunne fritt legge inn script-tagger
Qypher API bruker JavaScript for visning, QR-kodeanalyse og kommunikasjon med Qypher-kjernen.
Må kunne kommunisere med eksterne domener ved hjelp av fetch()
Qypher API sender dataene den analyserer til Qypher på et eksternt domene (https://qypher.be-on.biz) og mottar resultatene etter å ha sammenlignet med Qypher-data.
Må kunne bruke DOM-operasjoner med input type="file" og canvas-elementer
Qypher API bruker DOM-operasjoner for å laste opp Qypher-kort, analysere QR-koder og håndtere knapper.
Må kunne sette inn egendefinerte elementer i HTML
Qypher API legger til egendefinerte elementer i HTML før og etter pålogging.
Må kunne sette opp og kjøre server-side kode (som PHP)
Qypher API krever installasjon av en PHP-fil som inkluderer den hemmelige nøkkelen. Denne filen har ansvaret for å kryptere og dekryptere kommunikasjon med Qypher, verifisere engangsnøkler og andre kritiske oppgaver.
Når det ovennevnte er bekreftet, la oss gå videre til innstillingene.
Logg inn først på Qypher.
* Innloggingsmetoden er beskrevet i “Hvordan bruke Qypher”.
Klikk på Qypher-integrasjon, Integrasjonsdetaljer i Personopplysninger.
navnet på målnettstedet :
Skriv inn det offisielle navnet på nettstedet der Qypher skal implementeres.
nettadresse til Hjemmeside :
Skriv inn adressen til nettstedets landings- eller indexside, som starter med https.
Sandbox :
Så lenge “Sandbox” er valgt, vil produksjonens innloggingsskjerm vise “Under justering” og det vil ikke være mulig å logge inn. Når ulike tester er fullført, velg “produksjonsmiljø” og klikk “oppdater”.
antall registrerte :
Dette er antallet brukere som logget inn på ditt registrerte nettsted via Qypher. Den samme brukeren telles bare én gang selv om han logger inn flere ganger.
alder som krever foreldres samtykke :
Angi alderen hvor foreldresamtykke kreves. Hvis det ikke er nødvendig, velg “ingen begrensning”.
tillat alder for visning :
For nettsteder med aldersbegrensning, angi alderen. Hvis det ikke er nødvendig, velg “ingen begrensning”.
språk som brukes :
I fremtiden, når en liste over nettsteder som implementerer Qypher opprettes, vil seksjoner etter tilgjengelig språk bli gitt. Hvis nettleserens autotranslasjon fortsetter å utvikle seg, kan denne delen bli unødvendig.
ønskede data :
Velg brukerdataene du ønsker å hente fra Qypher. Hvilke data som kan hentes avhenger av abonnementet ditt. Vennligst sjekk “Planliste”.
nettadresse til Bruksvilkår :
Skriv inn URL-en til Bruksvilkår, som starter med https.
nettadresse til Personvernerklæring :
Skriv inn URL-en til Personvernerklæring, som starter med https.
nettadresse til etter innlogging :
Angi sideadressen som skal vises etter innlogging, både for Sandbox- og produksjonsmiljø, med start på https.
nettadresse til Webhook :
Angi URL-en for å motta webhook-informasjon for både Sandbox- og produksjonsmiljøet, med start på https. Hvis du ikke bruker det, kan du la det stå tomt. Webhooks er tilgjengelig med Pro-planer eller høyere.
mappe for API-hemmelig nøkkel :
Når du klikker på “Last ned API-sett (ZIP)”, genererer Qypher “Hemmelig nøkkelfil”. Skriv inn mappen der denne “Hemmelig nøkkelfil” skal plasseres, med start fra https.
Språktype for API-hemmelig nøkkel :
Akkurat nå tilbys bare PHP, men støtte for andre språk er planlagt. Da vil du kunne velge ønsket språk her.
Bruksplan :
Vennligst velg planen din. For detaljer, vennligst les Planliste.
Plasser innloggingssiden, API-hemmelig nøkkel, Bruksvilkår, Personvernerklæring, Webhook og siden etter innlogging innenfor samme domene, eller innenfor samme subdomene hvis du bruker subdomener.
For brukere med Pro-plan eller høyere som har flere nettsteder, velg nettstedet du vil redigere fra “Last ned API-sett (ZIP)”-nedtrekksmenyen.
Når innstillingene er ferdige, la oss laste det ned.
Når du klikker på “Last ned API-sett (ZIP)”, lastes en komprimert fil med navnet “QypherAPIset_(Nettstedsnavn).zip” ned til nedlastingsmappen din. Vennligst dobbeltklikk på den eller pakk den ut (åpne) på lignende måte.
Filstruktur
QypherAPIset_(Nettstedsnavn)/
├─ apiScript.txt ← Kopier og lim inn dette innholdet hvor som helst på innloggingssiden.
├─ En offentlig nøkkel bestående av 50 eller flere tilfeldige alfanumeriske tegn(1).php ← PHP-fil for håndtering av hemmelig nøkkel (Heretter omtalt som "privat nøkkelfil".)
├─ getData.php ← Vennligst kopier og lim inn dette innholdet på siden som vises etter innlogging.
├─ README.txt ← Brukermanual
└─ Sandbox/
├─ Sandbox_apiScript.txt ← ( for Sandbox ) Kopier og lim inn dette innholdet hvor som helst på innloggingssiden.
├─ Sandbox_En offentlig nøkkel bestående av 50 eller flere tilfeldige alfanumeriske tegn(2).php ← ( for Sandbox ) Hemmelig nøkkelfil
├─ Sandbox_getData.php ← ( for Sandbox ) Vennligst kopier og lim inn dette innholdet på siden som vises etter innlogging.
├─ nine.jpg ← Sandbox Qypher-kort testbruker på 9 år (Du kan teste handlinger som krever godkjenning fra foresatte.)
├─ eleven.jpg ← Sandbox Qypher-kort testbruker på 11 år (Kan brukes til å sjekke aldersgrensen for foresattgodkjenning.)
├─ thirty.jpg ← Sandbox Qypher-kort testbruker på 30 år (Kan logge inn som voksen på vanlig måte.)
└─ guardian.jpg ← Sandbox Qypher-kort testbruker som forelder til barn på 9 og 11 år (Bruk dette for å teste foresattgodkjenning.)
La oss prøve det i Sandbox
I Sandbox kan du utføre ulike eksperimenter og erfaringer knyttet til innlogging med Qypher.
Når du logger inn fra Sandbox, forblir alle handlinger i Sandbox og gjenspeiles ikke i produksjonsmiljø.
E-poster i Sandbox sendes kun til brukere som benytter Sandbox.
- Kopier alt innhold fra Sandbox_apiScript.txt og lim det inn hvor du vil på for Sandbox påloggingssiden.
Ved å sette ønskede data inn i value-attributtet til <input type="hidden" id="QypherAnyKey" value="">, kan de videreføres etter innlogging.
( Hvis det innskrevne innholdet inneholder HTML-tagger, JavaScript-kode, filbaner eller lignende, vil det automatisk bli ugyldiggjort. Dersom en skadelig value oppdages, kan bruk av Qypher bli deaktivert. )
- Plasser Hemmelig nøkkelfil for Sandbox på stedet angitt i mappe for API-hemmelig nøkkel inne i QypherIntegrasjonsdetaljer.
Plasser det på samme sted som for produksjonsmiljø. Ikke endre denne filen under noen omstendigheter. Hvis endret, kan det bli ugyldiggjort av kjernesystemet til Qypher, og påloggingsforespørselen kan bli avvist.
Ikke endre filnavnet. Qypher vil ikke kunne identifisere den.
Etter opplasting, kontroller at filrettighetene er riktig satt.
Anbefalt 604 eller 644
*Hvis du bruker en Windows-server, er ikke “604 / 644”-tillatelsene ovenfor nødvendige, men sørg for at filen er tilgjengelig for webserveren (f.eks. IIS) med riktige tillatelser.
- Kopier alt innhold fra Sandbox_getData.txt og bruk det som rammeverk for for Sandbox-siden etter innlogging.
Fyll inn innholdet etter innlogging i if($Qypher["success"]){} , og innhold ved feil i else{} .
Standardverdien ved en vellykket innlogging inneholder “Ved å laste inn siden på nytt må du logge inn igjen.”.
Et PHP-program limt inn på siden etter innlogging kaller Hemmelig nøkkelfil og dekrypterer disse dataene.
På dette tidspunktet blir den krypterte innloggingstidsstempelet verifisert som et engangspassord. Hvis dette tidsstempelet avviker med mer enn 5 sekunder, avvises innloggingen.
Dette er et viktig tiltak for å hindre at en annen person går tilbake til innloggingssiden og laster den på nytt etter at en bruker har logget ut, og dermed får tilgang.
Endringer inne i Hemmelig nøkkelfil kan skape en sikkerhetssårbarhet, så IKKE endre det under noen omstendighet.
La oss hente brukerdata fra Qypher
Det kan hentes i $Qypher-arrayet.
$Qypher["success"] ← true = Innlogging vellykket, false = Innlogging mislyktes
$Qypher["uuid"] ← Qypher-identifikator for innloggingslogg ( Brukes ved henvendelser til Qypher )
$Qypher["Qypher_ID"] ← Brukerens unike ID ( Bruk dette for å se hvilken bruker som logget inn )
$Qypher["login_time(UTC)"] ← YYYY-MM-DDThh:ii:ssZ ( Påloggingstiden er tilgjengelig i UTC )
$Qypher["meetsAgeReq"] ← «Om brukeren oppfyller nettstedets alderskrav» (1 = ja, 0 = nei). Vanligvis 1 ved vellykket innlogging. Den faktiske alderen og fødselsdatoen sendes aldri.
$Qypher["ageReq"] ← Aldersgrensen satt av nettstedet (0 = ingen)
$Qypher["guardianApproved"] ← Om brukerens alder er under terskelen for foreldrebekreftelse — needGuardian-verdien (13 hvis ikke satt; under 13 gjelder alltid uavhengig av innstillingen) (1/0). Qypher fullfører aldri en innlogging uten samtykke fra foresatte, så 1 betyr en ung bruker som logget inn med dette samtykket
$Qypher["under10"] ← Et grovt «under 10»-flagg (1/0), for å bytte til barnevennlig tekst eller utforming. Den faktiske alderen og fødselsdatoen sendes ikke; det endres bare én gang ved 10-årsgrensen, så gjentatte innlogginger kan ikke avsløre fødselsdatoen.
$Qypher["under13"] ← Et grovt «under 13»-flagg (1/0). Som under10 lar det deg bytte tekst etter aldersgruppe uten å motta den faktiske alderen; det endres bare én gang ved 13-årsgrensen.
$Qypher["QypherAnyKey"] ← Data som skal overføres fra innloggingssiden ( Dette er dataene skrevet inn i value-attributtet for id="QypherAnyKey" i apiScript.txt. )
$Qypher["json"] ← JSON-format av alle data ( Bruk dette til behandling i JavaScript og lignende )
Som standard gir Qypher de ovennevnte data.Hvis du krysser av for elementene i ønskede data i QypherIntegrasjonsdetaljer, vil mer data bli levert. Data som brukeren ikke har tillatt eller registrert, vil være tomme.
$Qypher["surname"] ← Etternavn
$Qypher["givenName"] ← Fornavn
$Qypher["nickname"] ← Kallenavn
$Qypher["email"] ← E-postadresse
$Qypher["birthday"] ← Fødselsdato
$Qypher["postalCode"] ← Postnummer
$Qypher["country"] ← Land / Region
$Qypher["area1"] ← Stat / Provins
$Qypher["area2"] ← By / Tettsted / Kommune
$Qypher["address"] ← Gate og nummer
$Qypher["building"] ← Bygningsnavn
$Qypher["room"] ← Romnavn
f.eks. echo `God dag {$Qypher["givenName"]} {$Qypher["surname"]}, Velkommen til Qypher.`;
Vennligst håndter personopplysninger med stor forsiktighet.
La oss forberede produksjonsmiljø
I produksjonsmiljø er de offentlige og private nøklene forskjellige fra de som brukes i Sandbox. Å bare kopiere innholdet i Sandbox vil ikke få produksjonsmiljø til å fungere.
Sett opp produksjonsmiljø ved å følge de samme trinnene som i Sandbox.
- Kopier alt innhold fra apiScript.txt og lim det inn hvor du vil på for produksjonsmiljø påloggingssiden.
Ved å sette ønskede data inn i value-attributtet til <input type="hidden" id="QypherAnyKey" value="">, kan de videreføres etter innlogging.
( Hvis det innskrevne innholdet inneholder HTML-tagger, JavaScript-kode, filbaner eller lignende, vil det automatisk bli ugyldiggjort. Dersom en skadelig value oppdages, kan bruk av Qypher bli deaktivert. )
- Plasser Hemmelig nøkkelfil for produksjonsmiljø på stedet angitt i mappe for API-hemmelig nøkkel inne i QypherIntegrasjonsdetaljer.
Plasser det på samme sted som for Sandbox. Ikke endre denne filen under noen omstendigheter. Hvis endret, kan det bli ugyldiggjort av kjernesystemet til Qypher, og påloggingsforespørselen kan bli avvist.
Ikke endre filnavnet. Qypher vil ikke kunne identifisere den.
Etter opplasting, kontroller at filrettighetene er riktig satt.
Anbefalt 604 eller 644
*Hvis du bruker en Windows-server, er ikke “604 / 644”-tillatelsene ovenfor nødvendige, men sørg for at filen er tilgjengelig for webserveren (f.eks. IIS) med riktige tillatelser.
- Kopier alt innhold fra getData.txt og bruk det som rammeverk for for produksjonsmiljø-siden etter innlogging.
Fyll inn innholdet etter innlogging i if($Qypher["success"]){} , og innhold ved feil i else{} .
Standardverdien ved en vellykket innlogging inneholder “Ved å laste inn siden på nytt må du logge inn igjen.”.
- Logg inn på Qypher, sett Sandbox i Qypher Integrasjonsdetaljer til produksjonsmiljø, og klikk på oppdater.
Hvis påloggingssiden viser “Kontrollerer installasjonsstedet”, sjekk om du ikke bruker Sandbox-versjonen, eller hvis du bruker Qypher på flere sider, sørg for å bruke den riktige for det nettstedet.
Bruk Webhook for å sikre påliteligheten av informasjonen din.
Webhook er tilgjengelig med Pro-planen og høyere. Etter at en bruker har logget inn, hvis informasjonen ikke kunne behandles riktig, bruk Webhook.
For brukere med Pro-planen og høyere, når du laster ned API-en, inkluderer mappen to filer: webhook.php og Sandbox_webhook.php. Bruk dem ved å legge til det du trenger slik de er.
Henting av data gjøres på samme måte som på siden etter innlogging.
Angi plasseringen der du plasserte filen i Qypher Integrasjonsdetaljer under Webhook, med start på https, og klikk på oppdater.
Hvis du ikke bruker Webhook, la Qypher Integrasjonsdetaljer under Webhook stå tomt og klikk på oppdater.