(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{476:function(e,t,a){"use strict";a.r(t);var s=a(63),o=Object(s.a)({},(function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"wolfeo-api"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#wolfeo-api"}},[e._v("#")]),e._v(" Wolfeo API")]),e._v(" "),a("p",[e._v("The Wolfeo API allows you to use Wolfeo as part of your production and website. The API provides a limited access to some of Wolfeo's features and functions. This API is subject to change and will be improved over time.")]),e._v(" "),a("h1",{attrs:{id:"getting-started"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),a("p",[e._v("The Wolfeo API is a "),a("strong",[a("em",[e._v("RESTful")])]),e._v(" API that returns a JSON response. Communication is via "),a("strong",[a("em",[e._v("HTTPS")])]),e._v(" and an "),a("strong",[a("em",[e._v("API Secret Key")])]),e._v(". An "),a("strong",[a("em",[e._v("API Secret Key")])]),e._v(" can be created in your settings inside your Wolfeo account.")]),e._v(" "),a("h1",{attrs:{id:"api-limits"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#api-limits"}},[e._v("#")]),e._v(" API Limits")]),e._v(" "),a("p",[e._v("The API has some limitations as below.")]),e._v(" "),a("p",[a("em",[e._v("Contacts limitations:")])]),e._v(" "),a("ul",[a("li",[e._v("Up to 2k Contacts can be added (START and PRO users).")]),e._v(" "),a("li",[e._v("Up to 10k Contacts can be added (ELITE users).")])]),e._v(" "),a("p",[a("em",[e._v("API calls limits:")])]),e._v(" "),a("ul",[a("li",[e._v("10 calls per second or 600 per minute.")])]),e._v(" "),a("p",[e._v("If you want to send more than 10 calls per second, you should consider to create your own queue. Wolfeo "),a("strong",[e._v("WILL REJECT")]),e._v(" any calls above these limits.")]),e._v(" "),a("h1",{attrs:{id:"creating-a-secret-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-secret-key"}},[e._v("#")]),e._v(" Creating a Secret Key")]),e._v(" "),a("p",[e._v("The first step in order to communicate with the Wolfeo API is to generate your secret api key. To do so, you "),a("strong",[e._v("MUST HAVE")]),e._v(" a Wolfeo paid account. The API won't work with free trial user accounts.")]),e._v(" "),a("p",[e._v("Log in to your Wolfeo account and then go to Settings then API.")]),e._v(" "),a("p",[e._v("Click on the Generate API key button to create your API key."),a("br"),e._v(" "),a("img",{attrs:{src:"https://d33v4339jhl8k0.cloudfront.net/docs/assets/5efc84b404286306f8060635/images/5fe8d0a5f24ccf588e3fea81/file-ytBvBFEszc.png",alt:""}})]),e._v(" "),a("p",[e._v("You can choose a name for your API key as you wish (optional):\n"),a("img",{attrs:{src:"https://d33v4339jhl8k0.cloudfront.net/docs/assets/5efc84b404286306f8060635/images/5fe8d0df495a886ca7828037/file-LSpR7wapfP.png",alt:""}})]),e._v(" "),a("p",[e._v("And finally click on Generate to see your API key.\n"),a("img",{attrs:{src:"https://d33v4339jhl8k0.cloudfront.net/docs/assets/5efc84b404286306f8060635/images/5fe8d109f24ccf588e3fea83/file-A46ZKC8jj1.png",alt:""}})]),e._v(" "),a("h1",{attrs:{id:"connecting"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#connecting"}},[e._v("#")]),e._v(" Connecting")]),e._v(" "),a("p",[e._v("Now that you have successfully generated your API key you can start to communicate with the API.")]),e._v(" "),a("p",[e._v("Here's an example of how you can communicate:")]),e._v(" "),a("div",{staticClass:"language-curl extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v('curl --request GET "https://api.wolfeo.me/api?demokey"\n')])])]),a("p",[e._v("If the connection is successful, the API will return")]),e._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[e._v('"success"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[e._v('"email"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"admin@wolfeo.me"')]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),a("p",[e._v("the email returned is the email associated with the account the API key belongs too.")])])}),[],!1,null,null,null);t.default=o.exports}}]);