Бір қосылым — бір ресурс
REST API пішінінің жоғарғы бөлігі: атау, қызмет, негізгі мекенжай, аутентификация және қосымша тақырыптар. api.example — оқу мекенжайы.
REST API үшін ресурс мекенжайы, әдіс, сұрау параметрлері және жауапты талдау қосылымда бапталады. Басқа ресурс немесе әдіс үшін басқа қосылым жасаңыз. Дереккөз блогы өз таңдау параметрлерін қоса алады; қабылдаушы сұрау денесін кесте жолдарынан құрады.
Оқу
Дереккөз GET және POST әдістерін қолдайды. Жауап пішімдері: JSON, XML, CSV/TSV және JSON Lines; Content-Type бойынша автоматты анықтау мүмкін. Ішкі JSON массиві үшін жазбалар жолын, XML үшін элемент жолын көрсетіңіз. Кодтауды, CSV бөлгішін және тақырыпты тексеріңіз.
Жауап беттері
| Режим | Нені баптау керек |
|---|---|
| none | Бір жауап. |
| next_link | JSON/XML ішіндегі келесі сілтеме жолы. |
| page | Бет параметрінің атауы және бет өлшемі. |
| offset | Ығысу параметрі және топтама өлшемі. |
Жауап денесіндегі келесі бет сілтемесі CSV немесе JSON Lines үшін қолданылмайды. Беттеу қатесі шамадан тыс оқуға әкелмес үшін ең үлкен көлемді шектеңіз.
Жіберу
Қабылдаушы POST, PUT және PATCH әдістерін қолдайды. Сұрау денесі JSON, XML, пішін деректері немесе CSV болуы мүмкін. Жолдар жеке немесе топтамамен жіберіледі; пішін деректері әр сұрауға бір жол береді. Жеке жазбалар үшін ресурс жолы мынадай үлгіні қолдана алады: /orders/{{Номер}}.
OData
Dynamics 365 және 1C үшін нысандар жиынын, өрістерді және сүзгіні таңдаңыз. Бұл қосылымдарда еркін SQL сұраулары қолжетімсіз. Жаңартуға кілт өрістері қажет. Нақты құқықтар мен қолжетімді нысандар сыртқы жүйе конфигурациясына тәуелді.