API lýsing · Lyklar

Afturkalla þennan lykil

POST/v1/me/key/revoke

Afturkallar lykilinn sem beiðnin er undirrituð með, strax og fyrir fullt og allt, eins og að afturkalla hann í Stillingum → API. Hvaða gildi lykill sem er getur afturkallað sjálfan sig: fyrir skriftu sem er búin að nota lykilinn sinn, eða skipanalínutól sem skráir sig út. Eigandi aðgangsins fær venjulega tölvupóstinn.

Heimild
Hvaða gildur lykill sem er.
Takmarkaflokkur
read
Auðkenning
Undirrituð

Svör

200 OK

Lykillinn, nú afturkallaður. application/json · RevokedKey

  • keyobject
    3 reitir
    • idstring

      Passar við ^mk_(live|test)_[a-z0-9]{20}$.

    • status"revoked"
    • revoked_atstring (date-time)

Öll svör bera MK-Request-Id, auk RateLimit-Policy og RateLimit.

Villur

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

StaðaKóðiMerking
400invalid_requestBeiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar.
401invalid_signatureMK-* hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki.
401key_expiredGildistími lykilsins er liðinn.
401key_revokedLykillinn var afturkallaður.
401timestamp_out_of_rangeMK-Timestamp munar meira en 30 sekúndum frá klukku netþjónsins.
401nonce_reusedÞessi lykill hefur þegar notað þetta MK-Nonce.
403ip_not_allowedBeiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins.
429rate_limitedOf margar beiðnir. Bíddu í Retry-After sekúndur.
429too_many_concurrent_requestsOf margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang.
429key_suspendedLykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk.
500internal_errorEitthvað fór úrskeiðis hjá okkur.
502bad_gatewayUndirliggjandi þjónusta svaraði á óvæntan hátt.
503overloadedÞjónustan er undir of miklu álagi. Reyndu aftur eftir Retry-After sekúndur.
503service_unavailableÞjónustan er tímabundið ekki tiltæk.
504gateway_timeoutUndirliggjandi þjónusta svaraði ekki í tæka tíð. POST beiðni gæti samt klárast; reyndu aftur með sama Idempotency-Key.

Beiðni

# Signed by sign-headers.sh: see Authentication
curl https://public-api.myntkaup.is/v1/me/key/revoke \
  -X POST \
  $(./sign-headers.sh POST /v1/me/key/revoke | sed 's/^/-H /')
import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
// Every request this key signs after this fails.
const { key } = await client.revokeKey();
console.log(key.id, key.revoked_at);
from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
# Every request this key signs after this fails.
key = client.revoke_key()["key"]
print(key["id"], key["revoked_at"])

Svar

200 OK
{
  "key": {
    "id": "mk_live_4f9c2a7d1e0b8c6a5d3f",
    "status": "revoked",
    "revoked_at": "2026-11-03T10:15:10Z"
  }
}

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