developers.filelabel.co

The most advanced file labeling software in the world.

Learn more

auth

Authenticate with an apiKey

This will verify the user's account info and return the session details as well as the access token.
If you're running a server side application, you will need to store the token and send it on subsequent
requests with the "token" parameter.

@param (string) apiKey: The user's API key.

@return (object) user: The session data.

downloadPDF

Downloads the PDF data stored in the session.

After running saveGeneratedSource, the server will store the binary PDF data
containing the labels in the user's session. The user must be logged in to
access this method, and there must be a pdf in the session.
Example: https://filelabel.co/api/?action=downloadPDF

@param (string) action: "downloadPDF"

This method does not return anything, per se. It presents a download prompt for the PDF.

findDealers

Returns an XML feed containing filelabel.co dealers for use with Google Maps API.

More info: https://developers.google.com/maps/articles/phpsqlsearch_v3
Example: https://locator.filelabel.co/api/?action=findDealers&lat=28.800557&lng=-81.30693150000002&radius=25

@param (string) action: "findDealers"
@param (float) lat: latitude
@param (float) lng: longitude
@param (int) radius: radius in number of miles

@return (string) XML

getProjectMeta

Returns a meta object for a particular project.

The project meta contains important information for the project, including
the name, field names, print template and forms.
Example: https://filelabel.co/api/?action=getProjectMeta&project=541f3a4328012

@param (string) action: "getProjectMeta"
@param (string) project: A valid project ID.

@return (object) output

getProjects

Returns all the projects in the user's session. These are all the projects assigned to that user.

The project meta contains important information for the project, including
the ID, name, field names, print template and forms.
 
This example requires you to be logged in.
Example: https://filelabel.co/api/?action=getProjects

@param (string) action: "getProjects"

@return (object) output.projects

labelData

Send data to this endpoint from your remote application if you want to create labels.

@param (array) data
@param (string) app: The name of the remote application.

saveGeneratedSource

Takes a full HTML document as input, creates a PDF from it and stores that PDF in the session.

The html should be URL encoded with something like php's rawurlencode(); or JavaScript's encodeURIComponent();
Once you run this endpoint, run /downloadPDF to get the PDF file.

Example: https://filelabel.co/api/?action=saveGeneratedSource&html=<YOUR_HTML>&project=<YOUR_PROJECT>

@param (string) action: "saveGeneratedSource"
@param (string) html: URL encoded HTML string (full document)
@param (string) project: A valid project ID.
@param (int) count: The number of labels in the batch (used with counters).

@return (string) output.pdf

toggleStripColumnHeaders

Toggles a variable on the server related to how the server parses spreadsheet input.

If this value is true, the first row of a spreadsheet will be parsed out and discarded.

Example: https://filelabel.co/api/?action=toggleStripColumnHeaders

@return (bool) stripColumnHeaders

proAdd

Adds file label data to the database.

@param (string) project: A valid project ID associated with your account.
@param (array) data: (optional) An array of objects corresponding to a set of labels. If left unset, blank rows will be created.

@return (array) data

proAttach

Attach a new image to an existing database record.
 
@param (string) id: The ID for a valid database record
@param (string) image: A base64 encoded data URI
@param (string) project: A valid project ID associated with your account.

@return (string) image: The image URL after processing on the server.

proBarcode

Updates the database for a record associated with a barcode.

@param (string) barcode: A barcode generated by our system.
@param (string) status: Status of the item in question.
@param (string) location: Location of the item in question.

@return (object) data

proCreateReport

Creates a report of data selected by the user.

@param (string) project: A valid project ID associated with your account.
@param (array) data: An array of objects corresponding to a set of labels.
@param (string) name: The name of the report
@param (string) notes: Additional user notes (optional);

@return (string) report: a URL to the report.

proDelete

Deletes file label data from the database.

@param (string) project: A valid project ID associated with your account.
@param (array) data: An array of objects corresponding to a set of labels.

@return (array) data

proDeleteList

Creates a list of data selected by the user.

@param (string) project: A valid project ID associated with your account.
@param (string) id: List ID.

proEdit

Edits a database record (or a number of records).

@param (string) project: (optional) A valid project ID associated with your account.
@param (array) data: An array of objects corresponding to a set of labels.

@return (array) data

proEditUser

Edit account details for the specified user. This user must be owned by the logged in user.

Used to edit user details like name, company and password.

@param (string) id: The user ID.
@param (string) name: The user's name.
@param (string) company: The user's company.
@param (string) email: The user's email address.
@param (string) password: The user's password.
@param (string) passwordConfirmation: Should match the password parameter.
@param (array) projects: list of projects assigned to the user.

@return (object) user

proExport

Exports project data as a CSV.

@param (string) project: A valid project ID associated with your account.

@return (array) data

proFindTag

Find an RFID tag and the data associated with it. Find it by barcode or tag.

@param (string) barcode: A valid barcode in the system.
@param (string) tag: A valid tag in the system.

@return (string) tag: The 12 character unique RFID code.\
@return (string) id: The content ID.
@return (string) project: The project ID.
@return (data) The data associated with the RFID tag.

proGet

Gets the entire database table for a particular project, as well as some useful meta information.

@param (string) project: A valid project ID associated with your account.
@param (bool) getBarcodes: Set this parameter to return the barcodes with the data.

@return (object) form - The project entry form.
@return (object) meta
@return (object) fields
@return (array) data

proGetLastBarcode

Returns the last barcode number in the database.

@param (string) project: A valid project ID associated with your account.

@return (string) barcode
@return (string) prefix

proGetTags

Gets the RFID tags for a project indexed by the barcode.

@param (string) project: A valid project ID associated with your account.

@return (object) meta
@return (object) fields
@return (array) data

proHistory

Return the tracking history for a given project.

@param (string) project: Project ID

@return (object) output: The tracking data.

proIndex

Edits a database record for a document (or a number of records).

@param (string) project: A valid project ID associated with your account.
@param (array) data: (optional) An array of objects corresponding to a set of documents.
@param (array) id: (optional) An array of IDs related to a set of documents.

@return (object) output

proItem

Returns the full info about an item.

@param (string) project: A valid project ID associated with your account.
@param (string) id: A valid item ID.

@return (oubject) output

proListBy

Lists objects by field.

@param (string) project: A valid project ID associated with your account.
@param (string) field: A valid object field.
@param (string) key [optional]: A query key.
@param (string) val [optional]: A query value.

@return (object) output

proQuery

Returns a subset of data which corresponds to a key\value pair match.

@param (string) project: A valid project ID associated with your account.
@param (string) key: A valid field name on the project.
@param (string) val: The value you are searching for.

@return (array) data

proSaveList

Creates a list of data selected by the user.

@param (string) project: A valid project ID associated with your account.
@param (array) data: An array of objects corresponding to a set of labels.
@param (string) name: The name of the report

@return (string) report: a URL to the report.

proSearch

Returns a subset of data which corresponds to a number of key\value pairs.
This method is similar to the query method, but it allows you to search for more than
one field.

@param (string) project: A valid project ID associated with your account.
@param (array) data: A query array corresponding to your search.

@return (array) data

proTag

Updates the database for a record associated with an RFID tag.

@param (string) tag: A 12 character RFID tag generated by our system.
@param (string) status: Status of the item in question.
@param (string) location: Location of the item in question.

@return (object) data

proUserName

Returns the user's human readable name.

@param (string) id: A valid user ID.

@return (string) name

checkSession

Returns the session logged_in staus (true or false).

@return (bool) logged_in

editAccount

Edit account details for the user referenced in the active session.

Used to edit user details like name, company and password. You must be logged in to use this.

@param (string) name: The user's name.
@param (string) company: The user's company.
@param (string) email: The user's email address.
@param (string) oldPassword: If you're changing the password, provide this.
@param (string) password: The user's password.
@param (string) passwordConfirmation: Should match the password parameter.   

@return (object) user

editSubscription

Edit account details for the user referenced in the active session.

Used to edit user details like name, company and password. You must be logged in to use this.

@param (string) name: The user's name.
@param (string) company: The user's company.
@param (string) email: The user's email address.
@param (string) oldPassword: If you're changing the password, provide this.
@param (string) password: The user's password.
@param (string) passwordConfirmation: Should match the password parameter.

@return (object) user

getSession

Displays the user's session information.

This endpoint can be used to get the user's project list or other useful info.

@return (object) session: The session data.

getStripeAccount

Edit account details for the user referenced in the active session.
 *
Used to edit user details like name, company and password. You must be logged in to use this.
 *
@param (string) name: The user's name.
@param (string) company: The user's company.
@param (string) email: The user's email address.
@param (string) oldPassword: If you're changing the password, provide this.
@param (string) password: The user's password.
@param (string) passwordConfirmation: Should match the password parameter.
 *
@return (object) user

login

Log the user in.

This will verify the user's account info and return the session details as well as the access token.
If you're running a server side application, you will need to store the token and send it on subsequent
requests with the "token" parameter.

@param (string) email: The user's email address.
@param (string) password: The user's password.

@return (object) user: The session data.

register

Register a new user.

@param (string) name: The user's name.
@param (string) company: The user's company.
@param (string) email: The user's email address.
@param (string) password: The user's password. If no password is provided, one will be generated.
@param (string) agree: Whether or not the user agrees to the terms of service.

@return (object) user: The data submitted to this endpoint.

resetPassword

Reset the user's password with a verification token from an email.

@param (string) reset: A valid reset verification token on the server.
@param (string) email: The user's email address.
@param (string) password: The user's password.
@param (string) passwordConfirmation: Should be identical to the password.

@return (bool) success: Upon success, this variable will be true.

unregister

Delete a user. The user most be owned by the logged in user.

@param (string) id: The user id of the user to remove.