Детальніше про ендпоінти

API (Application Programming Interface) — це набір правил, за якими різні програми можуть спілкуватися між собою.

Ендпоінт (кінцева точка API) — це конкретна адреса в API, через яку можна отримати або надіслати дані.

Наприклад, ви відкриваєте банківський застосунок і бачите точний баланс на власному рахунку. Усе через те, що ваш телефон відправляє запит на сервер банку через певну адресу (це і є ендпоінт). Сервер знаходить інформацію про баланс і повертає її вам.

Отже, ендпоінт – це як двері в кімнату, де зберігаються дані. Кожні двері ведуть до своєї кімнати, і ви можете відкрити тільки ті двері, до яких у вас є ключ.

Кожен ендпоінт у YouScore повертає вам певний набір даних. Наприклад, ендпоінт /v1/usr/ за кодом ЄДРПОУ поверне дані про юридичні особи, отримані з Єдиного державного реєстру юридичних осіб, фізичних осіб-підприємців та громадських формувань (ЄДР).

Детальніше про модулі та ендпоінти можна дізнатись у Swagger або за допомогою документації API у двох форматах на вибір: HTML та PDF (доступні для завантаження у Swagger).

Swagger — це інтерактивна документація API, яка дозволяє переглядати перелік доступних ендпоінтів безпосередньо у браузері. Вона дає змогу ознайомитися з кожним з них, переглянути приклади відповідей, структуру даних та параметри запитів, а також протестувати роботу API безпосередньо в інтерфейсі.

Щоб протестувати YouScore — перейдіть до Swagger, введіть свій API-ключ* і виконайте кілька запитів, щоб на практиці побачити, як працюють ендпоінти.

*API-ключ — це унікальний ідентифікатор, який використовується для доступу до API (аналог логіна і пароля). Тестовий API-ключ можна отримати у менеджера.

• Дані — містять інформацію, отриману безпосередньо з відкритих реєстрів, наприклад, ЄДРПОУ, назва компанії, адреса, контактні дані тощо.
• Аналітика — містить аналітичну інформацію, яку збирають та обробляють фахівці компанії YouControl, наприклад, рівень ретельності, з якою рекомендується здійснювати перевірку досліджуваної компанії її контрагентам, приналежність до ФПГ, наявність компанії у списках санкцій тощо.
• Кастомні — це дані, які не входять до стандартного набору та надаються за окрему плату. Це можуть бути, наприклад, відслідковування новостворених компаній і ФОП.