How to: Setting up

Introduction

Before we start implementing our first Camera to Cloud device, let’s get set up for success!

Sign up to be a developer!

You’ll need to have client_secret or client_id for your device to follow along with implementation guides. If you haven't already done so, check out this article for signing up to be a C2C developer, and we can get the ball rolling on issuing you the credentials you'll need to interact with the API.

Following along with the implementation guides

To follow along with this tutorial, it will be helpful to have the some tools at your disposal. These tools aren’t strictly necessary, but if you want to follow along with the guide, rather than just reading it, you’ll want to make sure they are set up and ready to go.

cURL

In these tutorials we will be making requests to Frame.io's servers using curl. libcurl is a popular library for making HTTP requests, and has a great command line interface to make them! When integrating your device, you will need to implement the same HTTP calls in your language of choice. For this tutorial we are using curl via the command-line interface so that you can try out making these calls yourself by copying and pasting commands into your shell environment.

To see if you have curl installed on your machine, type the following into your terminal:

curl --version

You should see an output like this:

curl 7.64.1 (x86_64-apple-darwin20.0) libcurl/7.64.1 (SecureTransport) LibreSSL/2.8.3 zlib/1.2.11 nghttp2/1.41.0
Release-Date: 2019-03-27
Protocols: dict file ftp ftps gopher http https imap imaps ldap ldaps pop3 pop3s rtsp smb smbs smtp smtps telnet tftp 
Features: AsynchDNS GSS-API HTTP2 HTTPS-proxy IPv6 Kerberos Largefile libz MultiSSL NTLM NTLM_WB SPNEGO SSL UnixSockets

If not, you can find installers for most operating systems here. If you are on MacOS or Linux, you can install curl via homebrew with the following command:

brew install curl

Python

We are going to use Python to pretty-print our JSON response payloads in these examples piping our curl results to:

curl https://api.frame.io/health | python -m json.tool

You can check if you have python installed by typing:

python --version

You should get a result like:

Python 2.7.16

If not, you can install Python here. The required version of Python is Python 2.6+. Prior versions of Python do not have the JSON pretty-printing functionality. Python 3.x is also compatible.

Python isn't required to follow the examples, but it might make reading the data sent back from Frame.io easier! Another tool you might be familiar with that can performa similar function here is jq.

Python reference implementation

In your developer bundle, you will also have received a Python reference implementation, which contains an example CLI app for uploading media to Frame.io as a C2C Connection. Once you get through each section of these guides, you may find it helpful to take a glance at the reference implementation to see the same concepts in working code.

Next up

If you haven’t already, we encourage you to reach out to our team, then continue to the next guide, which will be either for hardware device or C2C Application auth flow, depending on your integration type.

We look forward to hearing from you!