{"__v":77,"_id":"54c06e47a261ee0d0078a67f","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"The Vift API is organized around REST and makes use of built-in HTTP features such as HTTP Authentication. All API requests must be sent over HTTPS, and all requests must be authenticated. JSON is returned in all responses.\n\n**The core of the API is the [orders resource](doc:order-object).** You can create and update orders, retrieve order details, and cancel orders via the API.\n\n#How it works\n1. After a customer has completed a checkout on your website, you make a POST request, creating a new order object.\n2. A unique URL is generated by Vift and is sent to you in the response.\n3. You deliver the unique URL to your customer however you want: display a button with their receipt or send it to them in an email. \n4. You update the order object with delivery information.\n5. When the package is delivered, Vift notifies the recipient about their video message.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Integration\"\n}\n[/block]\nIntegrating the Vift API is meant to be a painless process. In most scenarios, you will only be making two API requests per order: one to create an order, and one to let Vift know how to handle delivery.\n\n[Learn more about Creating A New Order](doc:creating-a-new-order)\n\n[Learn more about Handling Delivery Notifications](doc:handling-delivery-notifications)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nAuthentication to the API occurs via HTTP Basic Authentication with TLS. Each of your calls must be authenticated by providing an App ID and API Key in the request. Your App ID serves as your authentication username and your API Key serves as your authentication password. All API requests must be sent over HTTPS.","category":"54c06e47a261ee0d0078a67e","createdAt":"2015-01-22T03:24:47.723Z","excerpt":"The Vift API enables you to manage your customers' orders of video gift messages through our platform.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"54c06d7e737c410d006ae0b0","slug":"getting-started","sync_unique":"","title":"Getting Started with Vift","type":"basic","updates":[],"user":"54c06d1c737c410d006ae0af","version":"54c06e46a261ee0d0078a67d","childrenPages":[]}

Getting Started with Vift

The Vift API enables you to manage your customers' orders of video gift messages through our platform.

The Vift API is organized around REST and makes use of built-in HTTP features such as HTTP Authentication. All API requests must be sent over HTTPS, and all requests must be authenticated. JSON is returned in all responses. **The core of the API is the [orders resource](doc:order-object).** You can create and update orders, retrieve order details, and cancel orders via the API. #How it works 1. After a customer has completed a checkout on your website, you make a POST request, creating a new order object. 2. A unique URL is generated by Vift and is sent to you in the response. 3. You deliver the unique URL to your customer however you want: display a button with their receipt or send it to them in an email. 4. You update the order object with delivery information. 5. When the package is delivered, Vift notifies the recipient about their video message. [block:api-header] { "type": "basic", "title": "Integration" } [/block] Integrating the Vift API is meant to be a painless process. In most scenarios, you will only be making two API requests per order: one to create an order, and one to let Vift know how to handle delivery. [Learn more about Creating A New Order](doc:creating-a-new-order) [Learn more about Handling Delivery Notifications](doc:handling-delivery-notifications) [block:api-header] { "type": "basic", "title": "Authentication" } [/block] Authentication to the API occurs via HTTP Basic Authentication with TLS. Each of your calls must be authenticated by providing an App ID and API Key in the request. Your App ID serves as your authentication username and your API Key serves as your authentication password. All API requests must be sent over HTTPS.