Fejlesztőknek

Építs a MemberAreára egy valódi REST API-val

Tagok, kurzusok, rendelések és fizetések egyetlen verziózott API mögött. Hitelesíts API-kulccsal vagy OAuth 2.0-val, reagálj aláírt webhookokra, és indulj az OpenAPI-specifikációból.

180
API-művelet
38
Webhook-esemény
34
OAuth-scope
curl
curl "https://api.memberarea.io/v1/members?per_page=5&include=tags" \
  -H "X-Api-Key: mak_your_key"
Gyorsindítás

Az első kérésed két perc alatt

Hozz létre egy API-kulcsot az adminban a Beállítások, API alatt. Küldd az X-Api-Key fejlécben vagy bearer tokenként, és minden válasz JSON-ként érkezik: a rekordok a data, a lapozás a meta mezőben.

  • Alap-URL: https://api.memberarea.io/v1
  • A kulcsok mak_ előtaggal kezdődnek, és csak egyszer látszanak
  • Oldalanként 25 rekord, per_page-dzsel legfeljebb 100
  • A tagokat UUID azonosítja, soha nem belső azonosító
API-referencia megnyitása
JSON
{
  "data": [
    {
      "id": "9b1f6c2e-4d0a-4c55-9a3e-2f7d1c8b6a10",
      "first_name": "Lena",
      "last_name": "Weber",
      "email": "lena@example.com",
      "status": 1,
      "created_at": "2026-10-02T09:14:00+00:00",
      "tags": [
        {
          "id": "4f2a9c71-0b3e-4d8a-a6c5-7e1d2b9f8a34",
          "name": "VIP",
          "color": "#f59e0b",
          "assigned_at": "2026-10-02T09:15:00+00:00"
        }
      ]
    }
  ],
  "meta": { "page": 1, "per_page": 5, "total": 128, "last_page": 26 }
}
Hitelesítés

API-kulcs a saját szkriptjeidhez, OAuth az alkalmazásokhoz

Egy API-kulcs egy fiókhoz tartozik, és szerver-szerver feladatokhoz való. Az az alkalmazás, amelyhez más MemberArea-fiókok csatlakoznak, OAuth 2.0-t használ authorization code folyamattal és PKCE-vel, így minden fiók pontosan azokat a scope-okat hagyja jóvá, amelyeket megad.

  • Alkalmazásokat a Beállítások, OAuth-alkalmazások alatt regisztrálhatsz
  • PKCE S256-tal, nyilvános és bizalmas kliensek
  • Az access token egy óráig, a refresh token 60 napig érvényes
  • Discovery: /.well-known/oauth-authorization-server
1. Engedélyezés
https://app.memberarea.io/oauth/authorize
  ?response_type=code
  &client_id=mac_your_client
  &redirect_uri=https://yourapp.com/callback
  &scope=members:read courses:read
  &state=random_state
  &code_challenge=BASE64URL_SHA256_OF_VERIFIER
  &code_challenge_method=S256
2. A kód beváltása
curl -X POST https://app.memberarea.io/oauth/token \
  -d grant_type=authorization_code \
  -d code=CODE_FROM_CALLBACK \
  -d redirect_uri=https://yourapp.com/callback \
  -d client_id=mac_your_client \
  -d client_secret=mas_your_secret \
  -d code_verifier=YOUR_VERIFIER
  • Részletes scope-ok

    Az olvasás és az írás erőforrásonként külön scope, például members:read, members:write, courses:read vagy payments:read.

  • Csere és visszavonás

    Bármikor visszavonhatsz egy kulcsot vagy tokent. A többi integráció tovább működik.

  • Csomaghoz kötött és nyomon követhető

    Az API-hozzáférés a fiók csomagjához igazodik, és minden kulcsnál látszik, mikor használták utoljára.

Webhookok

Aláírt események, tíz sorban ellenőrizve

A webhookok a Standard Webhooks specifikációt követik. Minden kézbesítés tartalmazza a webhook-id, webhook-timestamp és webhook-signature fejlécet: ez egy HMAC-SHA256 az azonosítóra, az időbélyegre és a nyers törzsre, a whsec_ titkoddal kulcsolva.

  • Utasítsd el az öt percnél régebbi kézbesítéseket
  • A sikertelen kézbesítéseket a rendszer automatikusan újrapróbálja
  • Minden próbálkozás bekerül a kézbesítési naplóba
  • Feliratkozás és leiratkozás API-n át a webhooks:manage scope-pal
Node.js
import crypto from "node:crypto";

export function verify(req, rawBody, secret) {
  const { "webhook-id": id, "webhook-timestamp": ts, "webhook-signature": sig = "" } = req.headers;
  if (!id || !ts || Math.abs(Date.now() / 1000 - Number(ts)) > 300) return false;

  const key = Buffer.from(secret.slice(6), "base64");
  const mac = crypto.createHmac("sha256", key).update(`${id}.${ts}.${rawBody}`).digest("base64");
  const expected = Buffer.from(`v1,${mac}`);

  return sig.split(" ").some((s) => {
    const given = Buffer.from(s);
    return given.length === expected.length && crypto.timingSafeEqual(given, expected);
  });
}

Korlátok és hibák

Kiszámítható korlátok, érthető hibák

Minden korlát megjelenik a válaszfejlécekben, és minden hiba azonos szerkezetű, így a kliens egyszer kezeli le őket.

  • Kéréskorlátok

    Percenként 600 olvasás, 120 írás és 30 automatizálási indítás, plusz napi korlát. Ezen felül az API 429-cel és Retry-After fejléccel válaszol.

  • Lapozás

    Bemenet: page és per_page. Kimenet a meta mezőben: page, per_page, total és last_page.

  • Egységes hibaformátum

    error.code a kódodnak, error.message az embereknek, error.details a hibás mezőknek.

  • Csomagkorlátok

    Ha egy fiók eléri a csomagja egyik korlátját, az API 402-vel és plan_limit_reached kóddal válaszol.

HTTP
HTTP/1.1 429 Too Many Requests
Retry-After: 12
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 0

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry in 12s.",
    "window": "minute"
  }
}

Erőforrások

Minden, ami az induláshoz kell

A referencia, a géppel olvasható specifikáció és az OAuth-metaadatok, mindig ugyanabból a forrásból generálva.

  • API-referencia

    Minden végpont paraméterekkel, példákkal és a szükséges scope-pal, a saját nyelveden.

    Referencia megnyitása
  • OpenAPI 3.1 specifikáció

    Importáld Postmanbe vagy Insomniába, vagy generálj klienst a saját programnyelveden.

    openapi.json letöltése
  • OAuth-metaadatok

    Végpontok, grant típusok és támogatott scope-ok RFC 8414 szerinti discovery dokumentumként.

    Metaadatok megtekintése
MemberArea

Kezdj el építeni a MemberAreán

Hozd létre az API-kulcsodat már a 14 napos ingyenes próba alatt.

Nem szükséges hitelkártya. Bármikor lemondható.