Community

Writing a JSON request for FlexiCapture Web Services

I am trying to figure out how Flexicapture's API works, and have downloaded and used the WSDL file to create SOAP requests. However, I cannot seem to find any information on how to send a JSON request. I know the web services don't support REST, but I see in the documentation that there's a JSON option, so does anyone know where I can find an example on how to use this option. For example, how do I make the following call (GetUsers method) with JSON instead of XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:flex="urn:http://www.abbyy.com/FlexiCapture">
<soapenv:Header/>
<soapenv:Body>
<flex:GetUsers/>
</soapenv:Body>
</soapenv:Envelope>

Was this article helpful?

0 out of 0 found this helpful

Comments

2 comments

  • Avatar
    Anton Kovalev

    I have the same problem.

    JSON API is mentioned in the documentation here:
    https://help.abbyy.com/en-us/flexicapture/12/developer/connecting/
    Bu there is ZERO (0) documentation about using it.

    Hey, ABBYY, would you be so kind to explain how to use it, please?

    0
  • Avatar
    Viktor Vovk

    Thank you for your question!

    We have documentation with code samples available here:

    Example of automatic processing

    Example of manual processing

    The following page below contains workflow examples for different types of tasks (scanning, verification, rescanning, etc):

    Using the Web Services API of the ABBYY FlexiCapture Application Server 

    In order to use the JSON API you should first authenticate your client and get an authentication token for future requests. To do so, please follow this article:

    Connecting to the Web Services API (abbyy.com)

    For example, to authenticate my client (Postman in this example) I created a request to the specified authentication endpoint with an "Authorization" header containing my username and password encoded in Base64 (it should be encoded in a "username:password" format) with the word "Basic" before it and the "application/json" header. 

    In response, I receive the AuthTicket and an authentication cookie that is appended to further requests to the API (you will need to save the received information for further API calls)

     

    To send a request to a specific method you should use the following format as your request body:

    {
        "MethodName": "<METHODNAME>",
        "Params": {
            "param1": value1
            "param2": value2
            ...        
        }
    }
     
    Please, refer to the aforementioned documentation for specific methods available in FlexiCapture API
    0

Please sign in to leave a comment.