Commands
Commands available to POP Engine™ partners.
Requests
Request structure
Internal Partner API commands are made using http POST requests to the endpoint:
https://pop.selfmgmt.com/api/1.0
Do not add trailing slash to target.
Content-type must be application/json.
Command name and parameters are given as JSON in the body of the request. All requests must include a "command" property specifying the command and most partner API commands require "partner_api" to be set to true.
{ "command": "(command)", "partner_api": true, . . . (additional request parameters) }Requests are authorized with Basic Auth using credentials supplied to partner by SMG.
Entity IDs
All numerical entity IDs are 64-bit unsigned integers. In requests they can be submitted as strings or integers.
Responses
Common fields
Every reply from POP Engine™ has these fields:
Name | Type | Description |
|---|---|---|
error_code | integer | 0: OK; anything else is an error |
error_text | string | Empty if error_code is 0; explanation of error for any other error_code |
command_from | string | Name of the command used to generate this response |
Entity IDs
In responses entity IDs are presented as strings.
Common error codes
Error code | Description |
|---|---|
1 | Not enough permissions |
5 | No partner account; see your SMG rep |
10 | Missing required parameter |
92 | Invalid command |
Pipe-separated config strings
Some responses use a pipe-separated (|) series of key-value pairs to encode numerous values in a single string. Such strings are formatted like this:
To extract key-value pairs, split the string at the pipe characters and treat the first, third, fifth etc. substrings as key names, and each subsequent substring as the value for that key, eg: