Skip to main content

Опис методів IDP сервісу

Дана інструкція описує послідовність викликів методів API, призначених для розпізнавання та перетворення PDF-файлів у структурні документи.

Відправка документа на розпізнання

Під час одного запиту можна надіслати лише один файл.

Опціонально: у параметрах запиту користувач може вказати from_user — логін користувача свого акаунту, від імені якого буде здійснено відправку.

REQUEST
URL  https://idp.edin.ua/api/docs/upload
Method POST
Header x-api-key={IDP_API_KEY}
 Body Content-Type: multipart/form-data

RESPONSEОпціонально: у параметрах запиту користувач може вказати from_user — логін користувача свого акаунту, від імені якого буде здійснено відправку.

    У відповідь надходить унікальний ідентифікатор (UUID) завдання на конвертацію.

    Приклад запиту:

    curl -v -H "x-api-key: {IDP_API_KEY}" -F upload='@{path to file}' https://idp.edin.ua/api/docs/upload
    RESPONSE

      У відповідь надходить унікальний ідентифікатор (UUID) завдання на конвертацію.

      Отримання списку файлів

      REQUEST
      URL https://idp.edin.ua/api/docs/search
      Method POST
      Header x-api-key={IDP_API_KEY}
      Body Content-Type: application/json

      У тілі запиту необхідно передати JSON об'єкт IDPTasksQuery.

      Опціонально: у параметрах запиту користувач може вказати from_user — логін користувача свого акаунту, від імені якого буде здійснено фільтрацію документів.

      Приклад запиту:

      curl -v -X POST -H "x-api-key: MY_TEST_API_KEY" -H "Content-Type: application/json" --data '{"status": ["DONE", "VERIFIED"]}' https://idp.edin.ua/api/docs/search
      RESPONSE
        Масив об'єктів IDPTask[].

        Приклад відповіді:

        [
  {
    "id": 293,
    "userId": 2000988,
    "uuid": "90c5f7ae-5747-4f56-bf07-068bfe8160cf",
    "status": "DONE",
    "date": 1753077616,
    "doneDate": 1753077643,
    "info": {
      "source": "API",
      "mimeType": "image/jpeg",
      "fileName": "300625_111323_1493.jpg"
    }
  }
]

        Отримання результату конвертації файлу

        REQUEST
        URL https://idp.edin.ua/api/docs/response?uuid={uuid завдання}
        Method GET
        Header x-api-key={IDP_API_KEY}

        Приклад запиту:

        curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/response?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf'

        Отримання вмісту файлу, відправленого на конвертацію

        REQUEST
        URL https://idp.edin.ua/api/docs/request?uuid={uuid завдання} Method GET Header x-api-key={IDP_API_KEY}

        Приклад запиту:

        curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/request?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf'

         

        Зміна статусу завдання

        REQUEST
        URL https://idp.edin.ua/api/docs/status?uuid={uuid завдання}&status=[CREATED|VERIFIED|PROCESSED]
        Method POST
        Header x-api-key={IDP_API_KEY}

        Приклад запиту:

        curl -v -H "x-api-key: {IDP_API_KEY}" 'https://idp.edin.ua/api/docs/status?uuid=90c5f7ae-5747-4f56-bf07-068bfe8160cf&status=PROCESSED'

         

        Back to top