Цей розділ призначений для розробників або тих, хто зацікавлений в інтеграції з Upwex. Upwex API надає доступ до різних кінцевих точок даних, дозволяючи вам інтегрувати функції Upwex
власні додатки або системи CRM. Нижче наведено огляд доступних кінцевих точок API та веб-перехоплювачів, а також інструкції щодо початку роботи.

API Endpoints

User and Team Data

  • GET me: Отримати дані про ваш обліковий запис користувача.
  • GET all team: Доступ до даних про членів вашої команди.
  • GET Upwork profiles: Отримайте інформацію про всі свої пов’язані профілі Upwork.

Analytics Data

  • GET overall analytics: Отримати загальні аналітичні дані.
  • GET analytics for Upwork profiles: Отримайте дані аналітики для ваших конкретних профілів Upwork.
  • GET opened_job / jobs: Переглянути всі відкриті вакансії.
  • GET bid / bids: Доступ до всіх ваших ставок або певної ставки.
  • GET reply / replies: Переглянути всі ваші відповіді або окрему відповідь.
  • GET invite / invites: Переглянути всі запрошення або конкретне запрошення.
  • GET direct_message / messages: Доступ до всіх ваших прямих повідомлень або певного повідомлення.

Ці кінцеві точки дозволяють вам інтегрувати дані Upwex у ваші власні системи, забезпечуючи ту саму аналітику та інформацію, що доступна в інтерфейсі Upwex.

Webhooks

Ви можете налаштувати вебхуки для отримання сповіщень у реальному часі, коли відбуваються певні події. Доступні вебхуки запускатимуться за таких подій:

  • opened_job.created: Ця подія спрацьовує щоразу, коли відкривається або переглядається нова вакансія.
  • bid.created: Ця подія відбувається, коли нова ставка (пропозиція) створюється та надсилається клієнту на Upwork.
  • reply.created: Активується, коли отримуєте відповідь на ставку або повідомлення, надіслане через Upwex.
  • direct_message.created: Ця подія запускається, коли від клієнта надходить пряме повідомлення, яке не є частиною існуючої пропозиції чи потоку ставок.
  • invite.created: Відбувається, коли клієнт надсилає вам або вашій команді запрошення подати заявку на роботу в Upwork.

Налаштувавши вебхуки, ваша програма може негайно реагувати на ці події, забезпечуючи бездоганну інтеграцію та автоматизацію.

Getting Started with Upwex API & Webhooks

Requirements

  1. Платна підписка: для доступу до API Upwex потрібна платна підписка. Підписка має мати Top Rated або вище. Ми не надаємо доступ до API без активної підписки.
  2. API Keys: Щоб отримати ключі API, виконайте такі дії:
    • Перейдіть до Tools & Apps в обліковому записі Upwex.
    • Натисніть на Upwex API.
    • Натисніть на Keys кнопку для створення або перегляду ключів API.
Upwex API & Webhooks Guide

Кроки для початку використання API

  • Створити ключ API: Натисніть “+ Create new key“
Upwex API & Webhooks Guide 2
  • у спливаючому вікні натисніть create:
Upwex API & Webhooks Guide 3
Upwex API & Webhooks Guide 4
  • Обов’язково надійно зберігайте свій ключ, оскільки він надає доступ до важливих даних і функцій.
    Примітка: Коли ключ буде згенеровано, ви не зможете переглянути його знову, тому обов’язково скопіюйте та надійно збережіть його.
Upwex API & Webhooks Guide 5

Ознайомтеся з кінцевими точками та параметрами API. Детальна документація доступна в нашій колекції Postman: Upwex API Documentation.

Налаштування веб-хуків

Upwex API & Webhooks Guide 6

Введіть URL-адресу, на яку ви хочете отримувати події вебхуку в реальному часі. Переконайтеся, що ваш сервер готовий обробляти вхідні запити, оскільки це дозволить отримувати сповіщення про такі події, як вакансії, пропозиції, відповіді, прямі повідомлення та запрошення.

Use Cases

  • CRM Integration: Синхронізуйте свої дані Upwex із системою CRM, щоб відстежувати ставки, відповіді та повідомлення в одному місці.
  • Custom Dashboards: Створюйте власні аналітичні панелі, використовуючи дані API Upwex.
  • Automated Notifications: Використовуйте веб-хуки, щоб запускати сповіщення або дії коли в Upwex відбуваються певні події.

Додаткова інформація

Для отримання більш детальної інформації, включаючи параметри запиту та формати відповіді, зверніться до нашої документації Postman: Upwex API Documentation.

Підтримка

Якщо у вас виникли запитання або потрібна допомога щодо API чи веб-хуків, зв’яжіться з нашою командою підтримки. Ми тут, щоб допомогти вам максимально використати можливості інтеграції Upwex.