Difference between revisions of "HTTP API/Developer's API key"

From SmartBots Developers Docs
Jump to: navigation, search
Line 1: Line 1:
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
 
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
Each time you use a SmartBots [[HTTP API]] command you need to send your personal Developer's key.
+
 
 +
Developer's API key is a kind of signature of a developer. Each [[HTTP API]] command requires it.
 +
 
 +
Imagine you've created some device to control bots, and then you sell it. You need three things to control bot:
 +
 
 +
# Developer's key - this identifies a developer of the device
 +
# Customer's bot name - which bot script is going to control
 +
# Customer's bot access code - confirms that script has an ability to control that bot
 +
 
 +
You (developer) use the same "developer key" in all your devices. Bot name and access code changes for every customer (for example, using a config notecard).
  
 
== Obtaining the key ==
 
== Obtaining the key ==
Line 9: Line 18:
  
 
[[Image:Smartbots-developers-key.jpg|center|border|link=]]
 
[[Image:Smartbots-developers-key.jpg|center|border|link=]]
 +
 +
== Developing for yourself? ==
 +
 +
If you don't sell devices to other people, you still need to get a developer's key and use it for HTTP API commands.
  
 
{{NavMenu}}
 
{{NavMenu}}
  
 
__NOTOC__
 
__NOTOC__

Revision as of 21:15, 2 May 2017


Developer's API key is a kind of signature of a developer. Each HTTP API command requires it.

Imagine you've created some device to control bots, and then you sell it. You need three things to control bot:

  1. Developer's key - this identifies a developer of the device
  2. Customer's bot name - which bot script is going to control
  3. Customer's bot access code - confirms that script has an ability to control that bot

You (developer) use the same "developer key" in all your devices. Bot name and access code changes for every customer (for example, using a config notecard).

Obtaining the key

  1. Login to your SmartBots account
  2. Click on "Developers" menu at the left
  3. Locate your key at the top of the page:
Smartbots-developers-key.jpg

Developing for yourself?

If you don't sell devices to other people, you still need to get a developer's key and use it for HTTP API commands.