@@ -168,15 +168,16 @@ <h3>API Keys</h3>
168168
169169 < p >
170170
171- The datatracker does not use any form of API keys currently (03 Nov
172- 2017), but may do so in the future. If so, personal API keys will be
173- available from your < a href =" {% url 'ietf.ietfauth.views.apikey_index'%} " >
174- Account API Key </ a > page when you are logged in, and document keys
175- will be visible to document authors on the document status page when
176- logged in.
171+ The datatracker has some API endpoints that uses Personal API keys,
172+ rather than username/password login, see for example details for
173+ < code > {% url 'ietf.doc.views_ballot.api_set_position' %} </ code > further
174+ down on this page. Personal API keys are available from your < a
175+ href =" {% url 'ietf.ietfauth.views.apikey_index'%} " > Account API Key </ a >
176+ page when you are logged in.
177177
178178 </ p >
179179
180+ < h3 > Signing</ h3 >
180181 < p >
181182
182183 When sending notifications to other APIs, the datatracker may sign
@@ -194,20 +195,23 @@ <h3>API Keys</h3>
194195 < h3 id ="iesg-position-api "> IESG ballot position API</ h3 >
195196
196197 < p >
197- A simplified IESG ballot position interface, intended for automation,
198- is available at < code > {% url 'ietf.doc.views_ballot.api_set_position' %}</ code > .
198+
199+ A simplified IESG ballot position interface, intended for automation, is
200+ available at < code > {% url 'ietf.doc.views_ballot.api_set_position' %}
201+ </ code > . Access is limited to area directors.
202+
199203 </ p >
200204 < p >
201205 The interface requires the use of a personal API key, which can be created at
202206 < a href ="{% url 'ietf.ietfauth.views.apikey_index' %} "> {% url 'ietf.ietfauth.views.apikey_index' %}</ a >
203207 </ p >
204208 < p >
205- It takes the following parameters:
209+ The ballot position API takes the following parameters:
206210 </ p >
207211 < ul >
208212 < li > < code > apikey</ code > (required) which is the personal API key hash</ li >
209213 < li > < code > doc</ code > (required) which is the balloted document name</ li >
210- < li > < code > position</ code > (required) which is the position slug, one of: yes, noobj, block, discuss, abstain, recuse, norecord </ li >
214+ < li > < code > position</ code > (required) which is the position slug, one of: < tt > yes, noobj, block, discuss, abstain, recuse, norecord</ tt > . </ li >
211215 < li > < code > discuss</ code > (required if position is 'discuss') which is the discuss text</ li >
212216 < li > < code > comment</ code > (optional) which is comment text</ li >
213217 </ ul >
0 commit comments