Using the Web Apply API

Overview

Updated 11/18/2021

 

When Applicants apply to a posted job on your Careers Page, they’ll click on a button or link that brings them to what we call the “Apply Page”.  What happens next?

 

If you’re using the standard Avionté IFrame, then the Apply Page will load right into the same IFrame.  If you’re using the Dynamically Created IFrame, then the Apply Page opens in an IFrame that is custom-defined by your web developer.  But there’s a third way for Applicants to apply to posted jobs on your careers page: the Web Apply API.

 

The Web Apply API allows your web developer to design and code every aspect of the Apply Page to your exact specifications.  It requires a little more development work but also provides the greatest flexibility and customization for the design of your Apply Page.

 

 

The Technical Bits

Avionté has an endpoint that accepts applicant information and a Job ID in JSON format that a web developer can use to bypass the Avionté IFrame and create a custom Apply Page.

 

The location to post your JSON is:

https://mycompas.com/compasapi/api/applyAPI

 

Available Applicant Fields are:

Email - applicant email address (string)
Firstname - applicant first name (string)
Lastname - applicant last name (string)
Address - applicant street address (string)
City - applicant city (string)
State - applicant state (string)
Postalcode - applicant postal code (string)
Mobilephone - applicant mobile phone (string)
custom1 - applicant custom field 1 (string)
custom2 - applicant custom field 2 (string)
custom1name - applicant custom field 1 definition (string)
custom2name - applicant custom field 2 definition (string)
linkedin - applicant linkedin profile URL (string)
website - applicant personal website (string)
country - applicant country (string)
referred - if the applicant was referred (Boolean)
referredname - who referred the applicant (string)
resumefilename - filename of the resume (string)
resumefile - BASE64 encoded file (string)
coverletterfilename - filename of the cover letter (string)
coverletterfile - BASE64 encoded file (string)
resumetext - text of applicant’s pasted resume (string)
JobID - the alpha numeric req ID to assign the applicant to (string)

 

Required fields are:

firstname
lastname
apikey
jobID
email

 

Here’s an example of what the post data looks like:

{"firstname":"Bobby",
 "lastname":"Walnut",
 "country":"United States of America",
 "address":"111 Bartak",
 "city":"San Leandro",
 "state":"CA",
 "postalcode":"94542",
 "phone":"(200) 100-3000",
 "email":"applicant@email.com",
 "linkedin":"http://linkedin.com/profile/9458783564",
 "site":"http://mysite.com",
 "jobID":"BW193594587",
 "mobilephone":"510-111-1111",
 "homephone":"510-222-2222",
 "referred":true,
 "source":"http://www.indeed.com/search?stuff",
 "referredname":"Refer Name",
 "apikey":"FOUND IN YOUR JOB BOARD EDIT UNDER WEB APPLY API",
 "resumefilename":"resume.doc",
 "resumefile":"BASE 64 Encoded File"
}

 

 

Functional Limitations

Something to keep in mind when evaluating which method to use to present Applicants with an Apply Page is that while the Web Apply API allows for highly-customized Apply Pages, it’s not without its limitations.  Many of the integrated features of Avionté rely on the Web Apply Page that we provide in an IFrame.  When the Web Apply API is used, these integration points are lost.  The features you’ll lose when using the Web Apply API include:

  • Use of the resume parsing engine
  • EEO form data collection
  • Web Tests
  • Questionnaires

 

If you have any questions about this article, please feel free to contact your dedicated Customer Success Manager or support@mycompas.com

 

Back to Top

 

 

Articles in this section

Was this article helpful?
0 out of 0 found this helpful
Share