API

StrawLink provides HTTP-based API to facilitate integration with job boards and third-party tools.
Functionality is limited, but we are expanding it based on customer feedback. So keep those suggestions coming!

Authentication

All API methods require authentication and all actions are performed for the authenticating user.
At this moment, we support only HTTP Basic Authentication. When authenticating please use your regular login (e-mail) and password.

API Key

We provide special API key for every our customer. You can retrieve it by following link Get current API Key or you can generate new one with the Create new API Key link. Generation of new key resets previous one.

Alternative job URLs

To facilitate integration we provide alternative URL to access your jobs to start screening. It helps to visually understand to which job you are referring to.

where YOUR_API_KEY is your current API Key
and JOB_NAME_OR_ID is the job id/name which you gave when creating it.

Note: This URL does not require authentication.

Get authenticated Customer's details

To get details on current authenticated customer you need to perform GET request:

Response will be given in XML format, includes number of jobs, submissions and purchases.

Create Customer (sub-client)

To create new customer which is company your represnt ("child", "sub-client") you need to POST data to:

list of parameters to POST:

• firstname — First name
• lastname — Last name
• email — E-Mail

Response will be given in XML format, result will contain auto-generated password for the customer.

List all Customers (sub-clients)

To list all customers ("childs", "sub-clients") created by your account, you need to perform GET request:

Response will be given in XML format.

Get Customer's (sub-client) details

To get details on customer ("child", "sub-client") created by your account, you need to perform GET request:

where CUSTOMER_ID is the id of customer returned by "List all Customers"

Response will be given in XML format, includes number of jobs, submissions and purchases.

Create Job

To create new job record with our API you need to POST data to:

list of parameters to POST:

• name — Name/ID for job (how you identify this job for yourself, i.e. JrWebDev, etc.)
• clientemail — E-Mail of owner, if not specified it will be authenticated user. Can be only a "child" (sub-client) of authenticated user
• url — URL or E-mail to continue/redirect (can be URL of your job on job board, Craigslist, etc.)
• position — Position for this job
• resume — Screening requires resume? Can be 0 (no) or 1 (yes). Default is 0
• skills — Comma separated list of your skill names (i.e. General,Software,Math). If some skill does not exist for the given clientemail it will be copied from authenticated user. If it does not exist there either, skill will be skipped.

Response will be given in XML format, in case of success — job screening URL will be returned.

Get Applicant's screening status

To check if applicant was screened for the job you need to perform GET request:

where APPLICANT_EMAIL_BASE64 is the RFC 2045 Base64 encoded email of the job applicant
and JOB_NAME_OR_ID is the job id/name which you gave when creating it.

Response will be given in XML format.

List screening status of all Applicants

To check status of all applicants of the job you need to perform GET request:

where JOB_NAME_OR_ID is the job id/name which you gave when creating it.

Response will be given in XML format.