&frankly upload API & service API Reference

This service and API endpoint provides customers means to upload files (CSV, XLS and XLSX) to &frankly to be used in e.g. automated processing, for example for providing user & organization data to us for import into &frankly. The upload service is available as an API (allowing files to be uploaded and listed via REST/HTTPS), or as an Secure FTP (SFTP - also allowing only file upload and listing, not retrieve of data). Both means of transferring data to &frankly is encrypted and secure. Note that the service only allows uploading and listing files, not downloading files (meaning even someone that would get access to the credentials used to upload files would not be able to download the data, which reduces potential issues with GDPR in use of this specific service). The hostname/base URL is the same for both endpoints: upload.api.andfrankly.com.

For SFTP access, log in to upload.api.andfrankly.com (port 22) using an API token as password and username as specified on the Accounts => API Access page in your &frankly account. If you cannot connect, it may be because you need to allow SFTP traffic in your firewalls, and/or that you need to whitelist your sending IP-adresses in &frankly. Contact help@andfrankly.com for more information if you are having troubles connecting.

The below documentation provides details for the HTTPS API endpoint.

The OpenAPI/Swagger definition of this API is avalable here.

API Endpoint
https://upload.api.andfrankly.com
Contact: help@andfrankly.com
Schemes: https
Version: 0.1

Authentication

api_key

type
apiKey
name
Authorization
in
header

Paths

File upload

POST /v1/storage/uploadFile

Uploads a file to our secure storage area

file: file
in formData

The file to upload. Max file size 10Mb, allowed file formats: CSV, XLS, XLSX.

200 OK

Successful upload (text/plain)

type
string
400 Bad Request

Invalid token, Not allowed IP address (no response, text/plain) or error processing the file (JSON response explaining the error, application/json)

type
object
Response Content-Types: text/plain, application/json
Response Example (200 OK) 
"file.csv"
Response Example (400 Bad Request) 
{
  "details": [
    {
      "type": "file validation",
      "message": "Too big file"
    }
  ],
  "id": "82d83de3-0c6a-441b-9158-9d7de686fdc4",
  "message": "Incorrect file size"
}
File upload

GET /v1/storage/files

List all files currently uploaded

200 OK

List of all files (by name) currently on the file area

type
string[]
400 Bad Request

Invalid token or not allowed IP address

Response Content-Types: application/json
Response Example (200 OK) 
[
  "file.csv"
]
Documentation by Spectacle