Допълнителен API проект
Показвайте договорените операции на приложението, когато имате нужда от тях
Прегледайте обхвата на API за допустим проект и разграничете планираните маршрути от вече изградените крайни точки.
Приемайте API като дефинирана опция за проект.
- Прегледайте опцията
Проверете наличността на API и съответното предложение за проекта.
- Определете обхвата на маршрута
Определете бизнес операциите, които API трябва да предостави.
- Прегледайте каталога с маршрути
Прегледайте метода, пътя и планирания или текущ статус на всяка маршрутизирана връзка.
Добавете API, когато вашият проект се нуждае от такова.
API на проекта е незадължителна част от предложението. Прегледайте обхвата и условията му, преди да го активирате, вместо да приемате, че всяко приложение го включва.
Инструментите на API организират предложените маршрути по бизнес области. Уточненията помагат да се определи какво трябва да прави всяка операция преди нейното изпълнение.
Разграничете планираните маршрути от работещите крайни точки
Подгответе достъп за друга система. Проектът може да се нуждае от друго приложение, за да използва своите бизнес операции. Прегледайте предоставения обхват и възможности на API, вместо да приемате, че всяка функция е автоматично достъпна. Договорените операции определят до какво трябва да има достъп интеграцията.
Прегледайте каталога с маршрути. Каталогът показва метода, пътя, описанието и състоянието на всеки маршрут. Той помага да се разграничи предложената функционалност от крайните точки, регистрирани като активни. Това е практичен справочник при подготовката за използване на API.
Изберете правилната посока на интеграция. Използването на API на друг доставчик и предоставянето на достъп до вашето собствено приложение са различни изисквания. Външните връзки покриват първото; проектният API покрива договорения достъп. Изберете подхода, който отговаря на бизнес обмена, който искате.
Разграничете отворен API от външна връзка
API на проект предоставя договорените операции на вашето приложение. Външна връзка описва как вашето приложение използва друга услуга; те обслужват различни нужди.
Използвайте каталога на маршрутите, за да проверите метода, пътя и дали крайната точка е планирана или активна. Тази презентация не активира API за вашия проект.
Оценете опцията за API спрямо конкретна нужда
Определете кой ще използва данните на проекта и кои операции изисква тази интеграция. Това помага да се разграничи незадължителен обхват на API от връзка със съществуваща външна услуга.
За допустим проект прегледайте планираните маршрути и състоянието на изграждането им. Потвърдете съответната услуга и среда, преди да считате крайна точка за налична за интеграция.
От незадължителен обхват до потвърдено показване
Преглед на наличността и условията. Проверете опцията за API в текущото предложение за проект. Решете дали приложението се нуждае от тази функционалност, преди да я активирате.
Обяснете операциите. Прегледайте предложените бизнес операции и отговорете на въпроси относно очакваното им поведение. Следвайте етапите на подготовка и изграждане.
Вижте какво е актуално. Прегледайте каталога с маршрути и публикуваната референтна информация за активен проект. Планираният маршрут не е работеща крайна точка.
Определете обхвата на интеграцията, преди да добавите API
Обяснете какви операции са необходими на друга система и прегледайте условията на опцията. API трябва да осигурява договорен бизнес обмен.
Въпроси относно API на незадължителния проект
Това е опция, чиято наличност и цена се показват в актуалната оферта. Приложението може да работи и без активирането ѝ. Тази презентация не осигурява и не активира API за вашия проект.
Той описва планирана операция, която все още не е регистрирана като активна крайна точка. Използвайте състоянието на каталога и действителната публикувана справка, преди да започнете интеграция.
Изгледите на API на проекта показват областите, които трябва да бъдат достъпни, въпросите, инфраструктурата и състоянията на строителството. Изпълнете посочените предварителни условия и прегледайте получения каталог с маршрути.
Използвайте API документацията, която съответства на активния проект и съответната среда. Не използвайте пример за крайна точка или удостоверяване, който се основава само на планиран маршрут.
Те описват друга услуга, която вашето приложение използва. Това направление на интеграцията е различно от предоставянето на операциите на вашето приложение чрез API на проекта.