You can also view
You are viewing documentation for version 11. This is the most recent stable release!

Create App

You can use the REST API to create Apps programatically.

Request

POST https://cameratag.com/api/v11/apps.json

Parameters

Below is a list of parameters that this endpoint accepts.

Parameter Accepted Values Description Required
api_key a valid user api_key All App endpoints require authentcation Required
name * The name of your application Required
use_domain_auth true / false Turn on / off domain-based security Optional
domains[] * The authorized domain(s) for your app. To select more than one pass multiple domains[] params Optional
use_webhook true, false Turn on / off webhooks Optional
callback_trigger created, starred Should CameraTag perform callback after assets are created or starred Optional
callback_url * A URL for the server callback functionality. Optional
use_email true, false Turn on / off Email notifications Optional
email_trigger starred, created Should CameraTag send email after assets are created or starred Optional
notification_email * An email to receive asset notifications Optional
publish_signature_required true, false require a valid signature for publishing of new assets Optional
playback_signature_required true, false require a valid signature for playback Optional
wall_privacy all, none, starred Determins which assets are shown in videowalls connected to this app Optional
use_ftp true, false Turn on / off FTP syndication Optional
ftp_trigger created, starred Should CameraTag perform synication after assets are created or starred Optional
ftp_server * A FTP server for FTP syndication Optional
ftp_username * A FTP user name for FTP syndication Optional
ftp_password * ftp_password Optional
ftp_directory * A FTP directory for FTP syndication Optional
ftp_protocol ftp, sftp Optional
use_s3 true, false Turn on / off S3 syndication Optional
s3_trigger created, starred Should CameraTag perform synication after assets are created or starred Optional
bucket_name * The name of your S3 Bucket (for S3 Syndication) Optional
s3_directory * An optional subdirectry into which assets should be placed Optional
s3_privacy public-read, private, authenticated-read The privacy settings for assets created in your S3 bucket Optional
s3_use_sse true, false Use server side encryption on S3 Optional
s3_key * An AWS Key with access to create objects and set ACLs Optional
s3_secret * An AWS Secret with access to create objects and set ACLs Optional
use_youtube true, false Turn on / off YouTube syndication Optional
youtube_trigger created, starred Should CameraTag perform synication after assets are created or starred Optional
youtube_privacy public, private The privacy setting to videos created in your youtube account Optional
use_slack true, false Turn on / off Slack notifications Optional
slack_trigger created, starred Should CameraTag perform synication after assets are created or starred Optional
slack_url * The URL provided by the Slack webhook add-on Optional
slack_channel * The channel you would like us ti post to (starts with a #) Optional

Example Response

{
  "uuid": "63f9c870-72c4-0130-04c5-123139045d73",
  "name": "Homepage",
  "callback_url": "http://postb.in/4c5DrNQy",
  "notification_email": "chris@cameratag.com",
  "bucket_name": "cameratagtest",
  "crop_length": null,
  "s3_privacy": "public-read",
  "s3_directory": "terst",
  "s3_use_sse": false,
  "publish_signature_required": false,
  "playback_signature_required": false,
  "ftp_server": "ftp.myServer.com",
  "ftp_username": "username",
  "ftp_password": "password",
  "ftp_directory": "cameratag/directory/",
  "use_ftp": false,
  "use_s3": false,
  "use_youtube": false,
  "ftp_trigger": "created",
  "email_trigger": "created",
  "s3_trigger": "created",
  "youtube_trigger": "created",
  "wall_privacy": "starred",
  "photo_width": 640,
  "photo_height": 480,
  "media_factories": [
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 8,
      "uuid": null,
      "name": "720p",
      "width": 1280,
      "height": 720,
      "area": 921600,
      "extension": "mp4",
      "length": "",
      "bitrate": null,
      "asset_class": "Video",
      "is_system": null,
      "created_at": "2017-05-07T07:22:58.000Z",
      "updated_at": "2017-06-02T02:33:11.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": null
    },
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 10,
      "uuid": null,
      "name": "vga_thumb",
      "width": 1280,
      "height": 720,
      "area": 921600,
      "extension": "jpg",
      "length": "",
      "bitrate": null,
      "asset_class": "Video",
      "is_system": true,
      "created_at": "2017-05-07T07:23:16.000Z",
      "updated_at": "2017-06-02T02:33:25.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": null
    },
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 11,
      "uuid": null,
      "name": "vga_filmstrip",
      "width": 1280,
      "height": 720,
      "area": 921600,
      "extension": "jpg",
      "length": 30,
      "bitrate": null,
      "asset_class": "Video",
      "is_system": true,
      "created_at": "2017-05-07T07:23:17.000Z",
      "updated_at": "2017-06-02T02:33:37.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": null
    },
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 25,
      "uuid": null,
      "name": "waveform",
      "width": 2000,
      "height": 375,
      "area": 750000,
      "extension": "png",
      "length": null,
      "bitrate": null,
      "asset_class": "Audio",
      "is_system": true,
      "created_at": "2017-05-07T07:25:21.000Z",
      "updated_at": "2017-05-16T14:26:16.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": null
    },
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 26,
      "uuid": null,
      "name": "negative_waveform",
      "width": 2000,
      "height": 375,
      "area": 750000,
      "extension": "png",
      "length": null,
      "bitrate": null,
      "asset_class": "Audio",
      "is_system": true,
      "created_at": "2017-05-07T07:25:21.000Z",
      "updated_at": "2017-05-16T14:26:16.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": null
    },
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 27,
      "uuid": null,
      "name": "photo",
      "width": 640,
      "height": 480,
      "area": 307200,
      "extension": "jpg",
      "length": null,
      "bitrate": null,
      "asset_class": "Photo",
      "is_system": true,
      "created_at": "2017-05-07T07:25:21.000Z",
      "updated_at": "2017-05-16T14:26:16.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": null
    },
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 24,
      "uuid": null,
      "name": "mp3",
      "width": null,
      "height": null,
      "area": null,
      "extension": "mp3",
      "length": null,
      "bitrate": null,
      "asset_class": "Audio",
      "is_system": true,
      "created_at": "2017-05-07T07:25:21.000Z",
      "updated_at": "2017-05-07T07:25:21.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": null
    },
    {
      "camera_id": "63f9c870-72c4-0130-04c5-123139045d73",
      "id": 54116,
      "uuid": null,
      "name": "en_captions",
      "width": null,
      "height": null,
      "area": null,
      "extension": "VTT",
      "length": null,
      "bitrate": null,
      "asset_class": "Video",
      "is_system": null,
      "created_at": "2017-05-15T22:55:35.000Z",
      "updated_at": "2017-05-15T22:55:35.000Z",
      "fg_color": null,
      "deleted_at": null,
      "language": "en-UK_BroadbandModel"
    }
  ],
  "domains": [

  ]
}