Quick primer before you begin using the API
Service endpoints
FileSpin Public Cloud Service endpoints are listed below. All FileSpin services are over https.
| Service | Base URL |
|---|---|
| Javascript | <<JS_HOST>> |
| API | <<API_HOST>> |
| CDN | <<CDN_HOST>> |
Enterprise customers may have Service endpoints that are different from above public endpoints. Please contact FileSpin Support ([email protected]) if you are unsure.
API Key & Identifiers
API Key
This is the secret key that you will use to access FileSpin API. FileSpin will not disclose this to anyone except you. You should keep this well protected.
API KEY should not be used in a web client that runs in a web browser. If you see API KEY in the web browser's developer console, you are using it incorrectly.
The API Key is unique to you. It is composed of 36 alphanumeric characters. It can be retrieved from FileSpin Dashboard by visiting Security page.
Unique Identifiers
Following are identifiers used within FileSpin service:-
Asset ID
This is a unique identifier for a file within our service. It is composed of 36 alphanumeric characters, like 678d1dbb934c4a42aa4833e893346857
Asset ID for an asset can be found in FileSpin Dashboard (Assets List View)
When you integrate an application with FileSpin.io, this is the ID you would store within your application to retrieve an Asset at any point.
Upload Key
This is the Key for use in the File Picker for associating a file upload with your FileSpin account. The Upload Key is unique to you. It is composed of 36 alphanumeric characters.
UPLOAD KEY cannot be used anywhere except with File Picker to upload assets. It cannot be used to view or access uploaded assets.
Upload Key will be visible in web browser developer console when using File Picker. This is not a security issue since Upload Key only allows asset upload and does not allow asset access.
Access ID
This is a unique ID associated with a user account. This may be required to retrieve signed URLs using certain APIs. Access ID can be retrieved from FileSpin Dashboard by visiting Security settings page.