API Upload Project Assets - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:21Z

Remove username/password API auth; ApiKey only

← Older revision		Revision as of 11:55, 25 July 2026
Line 9:		Line 9:
	! Field !! Required !! Description		! Field !! Required !! Description
	\|-		\|-
	\| <code>ApiKey</code> \|\| Yes* \|\| Private API key for your site~~. Prefer this over username/password.~~		\| <code>ApiKey</code> \|\| Yes \|\| Private API key for your site.
	\|-
	~~\| <code>Username</code> / <code>Password</code> \|\| Yes* \|\| Alternate auth if not using ApiKey~~.
	\|-		\|-
	\| <code>FairId</code> \|\| Yes \|\| Fair GUID from the site URL (<code>f</code> query parameter).		\| <code>FairId</code> \|\| Yes \|\| Fair GUID from the site URL (<code>f</code> query parameter).
Line 18:		Line 16:
	\|}		\|}

	* Provide '''either''' <code>ApiKey</code> '''or''' <code>Username</code>+<code>Password</code>.

	Calls must be run '''server-side''' — do not expose your API key in a browser.		Calls must be run '''server-side''' — do not expose your API key in a browser.

2026-07-25T18:49:47Z

Document image and paperwork upload

2024-04-11T03:58:18Z

← Older revision		Revision as of 20:58, 10 April 2024
Line 10:		Line 10:
	headers:{'Content-Type': 'application/json'},		headers:{'Content-Type': 'application/json'},
	body: JSON.stringify({		body: JSON.stringify({
	~~Username~~:'~~admin username',~~		ApiKey:'<Private key>',
	~~Password: 'password~~',
	FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f		FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
	Body: {		Body: {

2021-11-03T21:10:34Z

2021-08-19T22:56:00Z

← Older revision		Revision as of 15:56, 19 August 2021
Line 2:		Line 2:

	=== Upload Project Image ===		=== Upload Project Image ===
	You can use our ~~api~~ to upload images to a project, so these can be viewed by your judges or in the showcase. To do this you need to POST a message to your site. Below is an example of what needs to be posted.		You can use our API to upload images to a project, so these can be viewed by your judges or in the showcase. To do this, you need to POST a message to your site. Below is an example of what needs to be posted.

	<syntaxhighlight lang="JavaScript" line>		<syntaxhighlight lang="JavaScript" line>
Line 29:		Line 29:

	=== Upload Project Paperwork ===		=== Upload Project Paperwork ===
	You can use our ~~api~~ to upload project paperwork, so these can be viewed by your judges, SRC, and IRB. These files need to be PDFs~~, you~~ will need to get the PaperworkFileType form the [[API Get Info]]. To do this you need to POST a message to your site. Below is an example of what needs to be posted.		You can use our API to upload project paperwork, so these can be viewed by your judges, SRC, and IRB. These files need to be PDFs. You will need to get the PaperworkFileType form the [[API Get Info]]. To do this, you need to POST a message to your site. Below is an example of what needs to be posted.

	<syntaxhighlight lang="JavaScript" line>		<syntaxhighlight lang="JavaScript" line>

2020-11-25T03:33:47Z

Upload Project Paperwork

← Older revision		Revision as of 20:33, 24 November 2020
Line 45:		Line 45:
	"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...", //not required if you use DownloadFromUrl		"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...", //not required if you use DownloadFromUrl
	"DownloadFromUrl":"http://yoursite.com/somefile.png", //optional can be used in stead of Base64String		"DownloadFromUrl":"http://yoursite.com/somefile.png", //optional can be used in stead of Base64String
	"FileName": "myAwesomeFile.png",		"FileName": "myAwesomeFile.png"
	~~"Caption": "indescribable~~"
	}		}
	})		})

2020-11-23T21:37:05Z

← Older revision	Revision as of 14:37, 23 November 2020
(No difference)

2020-11-23T21:34:18Z

← Older revision		Revision as of 14:34, 23 November 2020
Line 1:		Line 1:
	== Upload Project Image ==		== Upload Project Assets ==

			=== Upload Project Image ===
	You can use our api to upload images to a project, so these can be viewed by your judges or in the showcase. To do this you need to POST a message to your site. Below is an example of what needs to be posted.		You can use our api to upload images to a project, so these can be viewed by your judges or in the showcase. To do this you need to POST a message to your site. Below is an example of what needs to be posted.

Line 26:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

	== Upload Project Paperwork ==		=== Upload Project Paperwork ===
	You can use our api to upload project paperwork, so these can be viewed by your judges, SRC, and IRB. These files need to be PDFs, you will need to get the PaperworkFileType form the [[API Get Info]]. To do this you need to POST a message to your site. Below is an example of what needs to be posted.		You can use our api to upload project paperwork, so these can be viewed by your judges, SRC, and IRB. These files need to be PDFs, you will need to get the PaperworkFileType form the [[API Get Info]]. To do this you need to POST a message to your site. Below is an example of what needs to be posted.

2020-11-23T21:33:34Z

@@ Line 13: / Line 13: @@
              Body: {
 				"ProjectKey":"32161f13-474b-442f-ac1f-edca7348e000",
 				"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...", //not required if you use DownloadFromUrl
 				"DownloadFromUrl":"http://yoursite.com/somefile.png", //optional can be used in stead of Base64String

2020-11-09T21:41:52Z

← Older revision		Revision as of 14:41, 9 November 2020
Line 4:		Line 4:
	<syntaxhighlight lang="JavaScript" line>		<syntaxhighlight lang="JavaScript" line>

	fetch('/api/data/project', {		fetch('/api/data/project/file', {
	method:'POST',		method:'POST',
	headers:{'Content-Type': 'application/json'},		headers:{'Content-Type': 'application/json'},