API Docs бетінде B2B Reference Hub платформасының бағдарламалық интерфейсі бойынша құжаттама бар.
Құжаттама білім базасының деректерін меншікті сервистерге, аналитикалық құралдарға немесе ішкі жүйелерге біріктіргісі келетін әзірлеушілер мен мамандарға арналған.
API платформаның материалдары, білім базасының құрылымы және iGaming индустриясының басқа да деректері туралы ақпарат алуға мүмкіндік береді.
API құрылымы
Құжаттама API негізгі элементтерін сипаттайды.
| API элементі | Сипаттамасы |
|---|---|
| Endpoint | API сұрау мекенжайы |
| Сұрау әдісі | Сервер сұрауының түрі |
| Параметрлер | Жіберілетін параметрлер |
| API жауабы | Қайтарылатын деректер пішімі |
| API қателері | Қате кодтары және олардың сипаттамасы |
Мұндай құрылым әзірлеушілерге API-мен жылдам жұмыс істеуге көмектеседі.
Негізгі API әдістері
API стандартты өзара іс-қимыл әдістерін қолдайды.
| Әдіс | Мақсаты |
|---|---|
| GET | Деректерді алу |
| POST | Деректерді жіберу |
| PUT | Деректерді жаңарту |
| DELETE | Жазбаларды жою |
Бұл әдістер стандартты REST архитектурасына сәйкес келеді.
Деректер пішімі
API деректерді құрылымдалған пішімде қайтара алады.
| Деректер түрі | Сипаттамасы |
|---|---|
| JSON | Негізгі алмасу пішімі |
| XML | Баламалы пішім |
| Мәтін деректері | Қосымша жауаптар |
| Метадеректер | Жарияланымдар туралы ақпарат |
Бұл әртүрлі жүйелермен үйлесімділікті қамтамасыз етеді.
Құжаттама кімге арналған
API құжаттамасы техникалық мамандарға арналған.
| Маманның түрі | Мақсаты |
|---|---|
| Жасаушылар | API интеграциясы |
| Интеграторлар | Жүйелерді қосу |
| Аналитиктер | Деректерді алу |
| Зерттеушілер | Білім базасын пайдалану |
| Индустрия компаниялары | Жеке сервистерді құру |
Бұл осы платформаларды басқа жобаларда пайдалануға көмектеседі.
Беттің мақсаты
API Docs беті B2B Reference Hub платформасының API пайдалану ережелерін сипаттайды.
Ол көмектеседі:- платформаны басқа жүйелерге біріктіру
- білім базасының деректерін пайдалану
- қосымшалар мен сервистерді әзірлеу
- ақпарат алуды автоматтандыру
API құжаттамасы платформаны әзірлеушілер мен интеграторлар үшін қолжетімді етеді.