RapidParser bar
RapidParser Header Image
Table of Contents

REST API Reference

RapidParser can be integrated as SOAP or REST service. In both cases, the parsing result can be obtained in XML or JSON format. You can freely choose between the different interfaces and result formats at any time. The results and parsing times remain similar over all different variants.

Service Endpoint

The REST-Service is located at:

https://www.rapidparser.com/api/rest

All method-URIs listed below are relative to this URL.

Method Descriptions

Method: Parse

Parse is the main function of RapidParser.

POST /v1/parse

Headers

Name Value Description
Content-Type “application/json” Only “application/json” is accepted. This is important as some applications or framework will default to “application/x-www-form-urlencoded” if no Content-Type is specified.
Accept “application/json”,“application/xml” Accept indicates how the result-string will be formatted. It either can be formatted as XML or JSON.
Authorization “Bearer Replace with one of your tokens.

Payload

Name Description
data CV converted to byte-array and encoded as base64-String. Depending on programming language and framework used you might only need to pass a byte-array.
filename The filename with filetype suffix of the passed CV. For example: John_Doe_CV.pdf

The REST-webservice only accepts JSON-formatted payload. The payload therefor needs to be encapsuled in a JSON-object:

{
  "data":"",
  "filename":""
}

Result

Detailed information regarding the returned result can be found here.

Example

FILENAME=John_Doe_CV.pdf
DATA=$( base64 $FILENAME)
curl \
-H "Content-Type: application/json; Accept: application/xml; Authorization: Bearer %TOKEN%" \
-X POST \
-d '{"data":"'"$DATA"'","filename":"'"$FILENAME"'"}' \
https://www.rapidparser.com/api/rest/v1/parse

Method: Status Check

The method 'Status Check' is intended to be a test-method in order to check if the RapidParser webservice generally is up and running. Furthermore you can use this method to retrieve your amount of remaining credits as well as their expiration date. 

POST /v1/status

Headers

Name Value Description
Content-Type “application/json” Only “application/json” is accepted. This is important as some applications or framework will default to “application/x-www-form-urlencoded” if no Content-Type is specified.
Accept “application/json”,“application/xml” Accept indicates how the result-string will be formatted. It either can be formatted as XML or JSON.
Authorization “Bearer Replace with one of your tokens.

Payload

No Payload

Result

Depending on the chosen output format this method should return 2 fields: The field 'credits' has the type Integer and contains the number of credits that remain for your account. The field 'expirationDate' has the type string and contains the expiration date for your credits in the MySQL like format "yyyy-mm-dd".

Example

curl \
-H "Content-Type: application/json; Accept: application/xml; Authorization: Bearer %TOKEN%" \
-X POST \
https://www.rapidparser.com/api/rest/v1/status