Към съдържанието
Разгледай демото 0

Модул в админ панела

REST API с ключове, които можете да отнемете

Админ → API Manager издава ключове, решава какво може всеки от тях и записва всяка заявка, която прави. Самото API е шест маршрута. Тази страница е цялото.

Попитайте го нещо

Всяко извикване носи ключ, в заглавка. Няма сесия, няма бисквитка и няма форма за вход.

С ключ

curl -H "Authorization: Bearer mpk_1a2b3c4d5e6f.…" \
     https://вашият-сайт/api/v1/posts

{
  "data": [ { "id": 12, "slug": "tseni", "lang": "bg", … } ],
  "meta": { "count": 34 }
}

Без ключ

curl https://вашият-сайт/api/v1/ping

{
  "error": {
    "code": "unauthorized",
    "message": "A valid API key is needed:
      Authorization: Bearer mpk_… or X-API-Key."
  }
}

Ключът може по-малко от вас, никога повече

Когато създавате ключ, отмятате обхватите, от които има нужда. После панелът реже този списък до това, което вие имате право да правите: ключ, направен от редактор, не може да чете поръчки, колкото и кутийки да са отметнати.

Маршрут, за който ключът няма обхват, отговаря с 403 и казва кой обхват е искал. Нищо не се отгатва и нищо не се подразбира.

Петте обхвата

  • posts.read — четене на публикувани страници и статии
  • orders.read — четене на поръчки
  • orders.write — създаване на поръчки, тоест връзки за плащане
  • customers.read — четене на клиенти
  • customers.write — създаване или допълване на клиенти

Шест маршрута, и това е списъкът

GET   /api/v1/ping                 без обхват, казва ви, че ключът работи
GET   /api/v1/posts                posts.read
GET   /api/v1/orders               orders.read
POST  /api/v1/orders               orders.write   -> връща връзка за плащане
GET   /api/v1/customers            customers.read
POST  /api/v1/customers            customers.write

Всичко друго отговаря с 404 и съобщение да погледнете в панела. Маршрутите не се променят, когато включвате или изключвате модул.

Показва се веднъж, пази се като хеш

Ключът изглежда така: mpk_1a2b3c4d5e6f.<40 hex>. Частта преди точката го идентифицира; тази след нея е тайната, а базата пази само SHA-256 от нея.

Затова панелът може да ви покаже ключа точно веднъж, когато го прави. След това никой не може да го прочете обратно — нито вие, нито администратор, нито някой с копие на базата. Ако се загуби, правите нов и изключвате стария.

Какво носи един ключ

  • Име, за да знаете за какво е
  • Своите обхвати
  • Собствен лимит на час
  • Срок на валидност, ако сложите такъв
  • Ключе вкл./изкл., което действа веднага

Лимити и лог, който се чете

Всеки ключ има собствен брой заявки на час, зададен при създаването му. Грешните ключове се броят отделно, по адрес: петдесет неуспеха за час и адресът се отказва, тъй че форматът на ключа не може да се отгатва на спокойствие.

Всяка заявка се записва — ключът, методът, маршрутът и статусът — и се пази 90 дни, после се изтрива. Когато една интеграция започне да се държи странно, отговорът е в таблица, а не в предположение.

API мениджърът в действие

Екранната снимка по-долу показва ключовете, маршрутите и формата за нов. С клик се отваря преглед в пълен размер.

API мениджър: ключовете с правата и лимита си, таблицата с маршрути и формата за нов ключ
Всеки ключ с това какво може и колко заявки на час получава. Самият ключ се показва веднъж, при създаването, и повече никога.