Как да се свържете с API на easySales: OAuth клиенти и лични токени за достъп
Създайте OAuth клиенти и лични токени за достъп до API на easySales, изберете правилния grant тип и обхвати и не позволявайте връзките да се изключват взаимно.
За какво служат настройките на API
API на easySales позволява на Вашите системи и на системите на Вашите партньори да четат и променят Вашите данни: продукти, наличности, поръчки, фактури и други. API Настройки е мястото, където създавате данните за достъп, които те използват. Отворете го от Настройки → Профил → Настройки с бутона API Настройки или от Настройки на страниците → Интеграции → API Настройки.
Три неща, които е добре да знаете отначало:
- Един активен токен на връзка. Когато една система поиска нов токен, предишният токен на същата връзка спира да работи. Дайте на всяка система собствен клиент и я оставете да използва повторно своя токен, вместо всеки път да иска нов.
- Личният токен за достъп се показва само веднъж. Копирайте го, когато го създавате. Ако го загубите, създайте нов; старият спира да работи.
- Избирайте обхватите внимателно. Един токен може да прави само това, което позволяват обхватите му, а обхватите не могат да се променят по-късно.
| Раздел | Какво съдържа |
|---|---|
| OAuth Клиент | Клиентите, с които Вашите системи получават токени, с техните Идентификационен номер на клиента, Grant тип и Таен ключ. |
| Оторизирани приложения | Приложенията, които имат токен от някой от Вашите клиенти от тип website или redirect, с техните обхвати. Oтменя спира едно от тях. |
| Личен токен за достъп | Вашите лични токени за достъп, по име. Изтрий спира един от тях. |
Създайте OAuth клиент
- Натиснете Създаване на нов клиент.
- Въведете Име, по което ще го разпознавате, например името на системата, която ще го използва.
- Изберете Grant тип. За Redirect Flow Grant въведете и URL адреса за пренасочване на Вашето приложение.
- Натиснете Създаване. Клиентът се появява в списъка със своите Идентификационен номер на клиента и Таен ключ.
| Grant тип | За какво се използва |
|---|---|
| Website Grant | Модул за онлайн магазин или собствен магазин, свързан с easySales. Освен идентификатора на клиента и тайния ключ, използва website токена на магазина, който получавате, когато свържете магазина в Интеграции. |
| Password Grant | Ваша собствена система, която получава токена си с данните за вход на Вашия профил в easySales. |
| Redirect Flow Grant |
Приложение, при което одобрявате достъпа в easySales и се връщате обратно в приложението. URL адресът за пренасочване трябва да използва име на хост, като localhost или домейн, а не IP адрес.
|
Редактирай променя само името и URL адреса за пренасочване. За да смените тайния ключ, създайте нов клиент, прехвърлете системата си към него и след това натиснете Изтрий при стария. Изтриването на клиент спира веднага всички токени, издадени с него.
Създайте личен токен за достъп
Личният токен за достъп е готов токен за скрипт, инструмент или партньор, на когото е нужно само да извиква API.
- Натиснете Създаване на нов токен.
- Въведете Име и отметнете в Обхвати тези, които са му нужни, или изберете избери всички.
- Натиснете Създаване и веднага копирайте токена.
Вашият профил има по един личен токен за достъп: създаването на нов прекратява предишния. Ако двама партньори се нуждаят от достъп, дайте им вместо това OAuth клиенти.
Използване на API
- Изпращайте заявките към
https://easy-sales.com/api/v2със заглавкитеAuthorization: Bearer, последвана от Вашия токен, иAccept: application/json. - Токените са валидни една година. Пазете токена и го използвайте повторно дотогава.
- Вашият профил може да прави до 500 заявки в минута, споделени между всички негови токени.
- Крайните точки, полетата и примерите са в документацията на API на api.easy-sales.com.
Вашият екип и настройките на API
Членовете на екипа с правото Преглед на настройките могат да отварят API Настройки и да виждат Вашите OAuth клиенти, включително техните тайни ключове, но не могат да ги създават, редактират или изтриват и не виждат личните токени за достъп. Давайте това право само на хора, които трябва да имат достъп до Вашите данни за достъп до API.
Когато нещо не изглежда наред
| Симптом | Какво да направите |
|---|---|
| API отговаря „Unauthenticated.“ | Токенът е заменен с по-нов от същия клиент или е изтекъл. Използвайте по един клиент за всяка система и пазете токена, който е получила. |
| API отговаря „Invalid scope(s) provided.“ | Токенът няма обхвата, нужен за тази заявка. Създайте нов токен с отметнат обхват. |
| Загубих личния си токен за достъп | Той не може да бъде показан отново. Създайте нов; старият спира да работи. |
| API връща уеб страница вместо JSON |
Добавете заглавката Accept: application/json към заявките си.
|
| „Too Many Attempts.“ | Вашият профил е надхвърлил 500 заявки в минута. Забавете заявките си и използвайте повторно токена си. |
| Партньор загуби достъп, когато създадох токен | Създаването на личен токен за достъп прекратява предишния. Дайте на всеки партньор собствен OAuth клиент. |