Site Tools


developer_integration

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
developer_integration [2020/01/03 19:23] – [In-game Tracking] b0ardfacedeveloper_integration [2021/03/07 05:30] – Updated seed generation api doc to describe JSON format b0ardface
Line 193: Line 193:
   /api/generate?key=<api_key>   /api/generate?key=<api_key>
  
-Along with these additional parameters in the query string or POST data: +The body of this request should be a JSON object with the 
-  flags the desired flag string +following format:
-  seed  : the randomization seed (optional)+
  
-This will return a JSON response in one of the following formats:+  { 
 +    "flags"      : "<desired flag string>", 
 +    "seed"       : "<desired randomization seed; optional>", 
 +    "metaconfig" : <optional metaconfiguration object; see below> 
 +  } 
 + 
 +NOTE: For backwards compatibility, the flags and seed values may be 
 +passed as URL query parameters or formdata values in the body instead. 
 +To use metaconfigurations, you must use the JSON parameter format. 
 + 
 +The metaconfiguration object, and all fields within it, are optional. 
 +Note that when a metaconfiguration is specified, a "unique" seed is 
 +generated -- rerunning the same generation parameters later will 
 +result in a different seed. 
 + 
 +The metaconfig object has this format: 
 + 
 +  { 
 +    "hide_flags" : <bool> 
 +  } 
 + 
 +The generate call will return a JSON response in one of the following 
 +formats:
  
   // If the generation process started correctly   // If the generation process started correctly
developer_integration.txt · Last modified: 2023/12/26 20:45 by A User Not Logged in