Sækja lykil með tengikóða

Býr til lykil úr einnota kóða sem var búinn til í Stillingum → API (Tengja skipanalínuna), með dreifilykli lyklapars sem kallandinn bjó til sjálfur, svo einkalykillinn fer aldrei frá honum. Heiti, heimildir, leyfðar IP tölur og gildistími voru valin í Stillingum, eftir staðfestingu með rafrænum skilríkjum. Þarf ekki undirskrift: kóðinn er auðkenningin, notaður einu sinni og gildir í 10 mínútur. Óþekktir, notaðir og útrunnir kóðar fá allir svarið not_found. Mest 10 tilraunir á klukkustund frá hverri IP tölu.

Heimild: Engin. Þessi endapunktur þarf ekki undirskrift.
Takmarkaflokkur: Enginn (skyndiminni)
Auðkenning: Engin

Meginmál beiðnar

application/json · ClaimKeyPairingRequest. Óþekktum reitum er hafnað.

codestringskylda
Einnota kóðinn sem Stillingar → API sýna eftir Tengja skipanalínuna. Gildir í 10 mínútur.
Byrjar á mkp_. Dæmi: mkp_abcdefghijklmnopqrstuvwxyz.
public_keystringskylda
Ed25519 dreifilykill nýja lykilsins: bætin 32, í base64url án fyllingar.
Passar við ^[A-Za-z0-9_-]{43}$. Dæmi: 11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo.
clientobjectskylda
Hvað sækir lykilinn; eigandi aðgangsins sér það í Stillingum → API.
4 reitir
- namestringskylda
  1 til 40 stafir. Engin stýritákn. Dæmi: myntkaup-cli.
- versionstringskylda
  1 til 40 stafir. Engin stýritákn. Dæmi: 0.2.0.
- hostnamestringvalfrjálst
  1 til 100 stafir. Engin stýritákn.
- osstringvalfrjálst
  1 til 40 stafir. Engin stýritákn. Dæmi: darwin.

Svör

201 Created

Nýi lykillinn og aðgangur hans. application/json · Me

accountobject
3 reitir
- typestring (enum)
  Eitt af person, company.
- namestring
- tierstring
  Þóknunarþrep aðgangsins.
  Passar við ^tier-\d{1,3}$.
keyobject
6 reitir
- idstring
  Passar við ^mk_(live|test)_[a-z0-9]{20}$.
- namestring
- scopesfylki af string (enum)
- ip_allowlistfylki af string
- created_atstring (date-time)
- expires_atstring (date-time)getur verið null
  null fyrir ótímabundinn lykil.

Öll svör bera MK-Request-Id.

Villur

Villur nota villuumslagið. Greindu þær eftir code.

Staða	Kóði	Merking
400	`invalid_request`	Beiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar.
403	`api_access_disabled`	Slökkt er á aðgangi að API-inu.
404	`not_found`	Þetta fannst ekki.
413	`payload_too_large`	Meginmál beiðnarinnar er stærra en 8 KB.
415	`unsupported_media_type`	Meginmál beiðna verður að vera `application/json`.
422	`key_limit_reached`	Aðgangurinn er þegar með eins marga API lykla og hann má (5): afturkallaðu einn í Stillingum → API fyrst.
429	`rate_limited`	Of margar beiðnir. Bíddu í `Retry-After` sekúndur.
500	`internal_error`	Eitthvað fór úrskeiðis hjá okkur.
503	`overloaded`	Þjónustan er undir of miklu álagi. Reyndu aftur eftir `Retry-After` sekúndur.

curl https://public-api.myntkaup.is/v1/key-pairings/claim

import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
// The public half of a key pair you made; keep the private half.
const claimed = await client.claimKeyPairing({
  code: "mkp_abcdefghijklmnopqrstuvwxyz",
  publicKey: "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo",
  client: { name: "my-tool", version: "1.0.0" },
});
console.log(claimed.key.id, claimed.key.scopes);

from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
# The public half of a key pair you made; keep the private half.
claimed = client.claim_key_pairing(
    code="mkp_abcdefghijklmnopqrstuvwxyz",
    public_key="11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo",
    client={"name": "my-tool", "version": "1.0.0"},
)
print(claimed["key"]["id"], claimed["key"]["scopes"])

201 Created

{
  "account": {
    "type": "person",
    "name": "Jón Jónsson",
    "tier": "tier-1"
  },
  "key": {
    "id": "mk_live_4f9c2a7d1e0b8c6a5d3f",
    "name": "DCA bot",
    "scopes": [
      "account:read",
      "transactions:read"
    ],
    "ip_allowlist": [
      "203.0.113.10"
    ],
    "created_at": "2026-11-01T09:30:00Z",
    "expires_at": "2027-01-30T09:30:00Z"
  }
}

Grunnslóð https://public-api.myntkaup.is