Мақсаты және шектеулері

«API деректерін жариялау» сыртқы тұтынушы қай ағын кестесін алатынын анықтайды. Оны «API: деректерді қабылдау және жариялау» тобынан қосып, «Ағын деректерін жариялау» бағыты бар REST API қосылымын таңдаңыз. Кірісіне қажетті нәтижені жалғаңыз: түрлендіру шығысын, таңдалған бағыттау тармағын немесе қабылдаушы жазған деректерді.

Блок өз тармағын аяқтайды, шығыстары жоқ және кесте мәндерін өзгертпейді. Бір ағында бір ғана жариялау блогы болуы мүмкін. Түпкі нүкте бір жарияланған ағынға тиесілі; басқа түпкі нүкте үшін бөлек ағын жасаңыз. Пайдаланылған түпкі нүктелер жаңа бос қосылым ретінде қолжетімсіз.

Қосылым және беру режимі

Қосылым мекенжайды, API нұсқасын, JSON/JSON Lines/CSV/XML пішімін, ашық қатынауды және бет шегін анықтайды. Блок қасиеттерінде толық мекенжай мен техникалық анықтама сілтемесі бар. Блоктың өзі жауап әрекеті мен параметрлерін орнатады.

«Соңғы іске қосудың сақталған нәтижелері» соңғы аяқталған Production іске қосуының бар кестесін береді. GET ағынды орындамайды; өзектілікті кесте немесе басқа триггер қамтамасыз етеді. «Әр сұрау үшін ағынды іске қосу» Production орындайды және 1–120 секунд күтеді. 0–3600 секундтық қайта пайдалану баптауы бірдей сұрау үшін аяқталған нәтижені оқуға мүмкіндік береді. Нөл аяқталған нәтижелерді қайта пайдалануды өшіреді.

Сүзгілер және іске қосу параметрлері

Қажет болса 20 API параметріне дейін қосыңыз. Әрқайсысына атау, сипаттама, мақсат, қабылдаушы өріс немесе іске қосу параметрі, түр және міндеттілікті орнатыңыз. Атау латын әрпінен басталып, 40 латын әрпі, цифр немесе астын сызуға дейін қамтиды; offset, limit және run сақталған.

Сүзгі нәтижені мәтін, сан немесе күн бойынша таңдайды. Рұқсат етілген мәндер таңдауды шектейді; бірнеше таңдау URL ішінде параметр атауын қайталайды. Шеттері кіретін ауқым _from және _to жұрнақтарын қолданады. Барлық сүзгі беттеуден бұрын толық жиынға қолданылады. Іске қосу параметрі тек сұрау бойынша орындауда қолжетімді және тиісті ағын параметріне мән береді.

Жариялау, қатынау және тексеру

Ағынды сақтап, жариялаңыз. Сақталған нәтиже үшін алғашқы іске қосуды аяқтаңыз; онсыз оқылатын жиын жоқ. API клиентіне «Оқу» беріңіз; сұрау бойынша орындауда иесінің ағынды орындау құқығын тексеріңіз. Ашық қатынау қосылымда бөлек қосылады: содан кейін деректі кілтсіз оқуға болады, сондықтан тек мақұлданған ашық жиынды ұсыныңыз.

Бақылау GET, сүзілген жол санын және келесі бетті тексеріңіз. Орындау жалғасса, 202 жауабында next бар; Retry-After өткеннен кейін run.id сақтап сұраңыз. Белгісіз параметрлер қабылданбайды. 404 үшін аяқталған нәтиже бар-жоғын; 409 үшін жариялау күйін немесе дерек өзектілігін тексеріңіз. Толық мысалдар мынада: API жариялауын баптау.