API lýsing · Aðgangur

Aðgangurinn og þessi lykill

GET/v1/me

Tegund aðgangs, birtingarnafn og þrep, og auðkenni, heiti, heimildir, leyfðar IP tölur og gildistími þessa lykils.

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

Svör

200 OK

Aðgangurinn og lykillinn. 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, 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.
403account_restrictedAðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið).
403api_access_disabledSlökkt er á aðgangi að API-inu.
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 \
  $(./sign-headers.sh GET /v1/me | sed 's/^/-H /')
import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
const me = await client.me();
console.log(me.account.name, me.key.scopes);
from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
me = client.me()
print(me["account"]["name"], me["key"]["scopes"])

Svar

200 OK
{
  "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