es256-private.pem: oppbevar denne på maskinen som anroper API-et vårt. Del den aldri via e-post, chat, supportbillett eller koderepositorium.es256-public.pem: send dette til oss for oppstart.
Før du begynner
Du trenger OpenSSL 3.0 eller nyere. Sjekk med:- Windows: installer den via winget, Chocolatey eller Git for Windows.
- macOS: den innebygde versjonen kan være LibreSSL. Kjør
brew install opensslhvis utdataene ikke viser OpenSSL 3 eller nyere.
openssl ikke gjenkjennes, må du installere den og åpne et nytt terminalvindu.
Generer nøklene på maskinen som skal kalle API-et vårt, enten det er en server eller en bærbar PC, slik at den private nøkkelen aldri trenger å kopieres til et annet sted.
Trinn 1: Generer nøklene
Kjør disse kommandoene i PowerShell, Kommandoprompt, bash eller zsh. Den første oppretter den private nøkkelen (EC P-256, PKCS#8-format). Den andre genererer den tilhørende offentlige nøkkelen.Trinn 2: Bekreft nøklene
Kjør disse kommandoene før du sender noe.- Den første kommandoen skriver ut
Key is valid. - Den andre viser
ASN1 OID: prime256v1ogNIST CURVE: P-256. es256-private.pembegynner med-----BEGIN PRIVATE KEY-----.es256-public.pembegynner med-----BEGIN PUBLIC KEY-----.
BEGIN EC PRIVATE KEY, konverter den til PKCS#8:
Trinn 3: Beskytt den private nøkkelen
Begrens tilgangen til kontoen som kjører integrasjonen din:- I produksjonsmiljøet bør du lagre den i en hemmelighetsbehandler, for eksempel Azure Key Vault, AWS Secrets Manager eller HashiCorp Vault.
- Send den aldri via e-post, legg den ikke ved en supportbillett, lim den ikke inn i en chat eller legg den ikke inn i et repositorium. Hvis du tester med Postman, oppbevar den i Postman Vault eller kun som en midlertidig verdi.
- Hvis du tror den har lekket, må du gi oss beskjed umiddelbart.
Trinn 4: Send oss den offentlige nøkkelen
Send kunes256-public.pem til din Credit Benchmark-kontakt. Inkluder:
- Navnet på organisasjonen din
- Miljø (Sandkasse eller Produksjon)
- En teknisk kontaktperson
- Omfangene du trenger
- Nøkkelens fingeravtrykk
es256-public.pem og at det ikke er vedlagt noen privatnøkkelfil. Vi kan ringe din tekniske kontaktperson for å få bekreftet fingeravtrykket før nøkkelen aktiveres.
Så snart nøkkelen er registrert, sender vi deg velkomstpakken din. Se hva du mottar tilbake.
Nøkkelrotasjon
Bytt ut nøkkelparet minst én gang hvert 12. måned, eller umiddelbart dersom den private nøkkelen kan ha blitt kompromittert.1
Generer et nytt nøkkelpar
Gjenta trinn 1 og 2 med nye filnavn, for eksempel
es256-private-2027.pem.2
Send den nye offentlige nøkkelen
Send den som i trinn 4, med emnet
M2M API key rotation - [Your organisation name] - [Environment] og din eksisterende OAuthClientId.3
Motta en ny KID
Vi svarer med en ny
KID. Din OAuthClientId endres ikke.4
Bytt over
Bytt integrasjonen din til den nye private nøkkelen og
KID, og gi oss beskjed. Vi tilbakekaller den gamle KID , og du sletter den gamle private nøkkelen på en sikker måte.
