Developers can use Pulpstream's REST APIs to get and create records from an external program.

 

To interact with Pulpstream, the external program needs to send an apiKey parameter in the HTTP Header to connect with the right account. They can use any of the values in the API Key fields defined in Company Information. Each of them is a unique identifier for the company's account.

 

When they send apiKey, the calling program has access to all data available in that account. In addition, the calling program can add an apiUserName parameter to the HTTP header. That option specifies the username associated with a specific user (as defined in the User settings). In that case, the calling program only sees data that can be accessed by that user.

 

Developers can use tools such as POSTMAN Extension on Chrome to try the APIs

 

Notes:

• The API keys are generated by Pulpstream to uniquely identify the company account.
• There are two API keys, so that one gets old enough to be retired--the other key remains valid.
• Each key can be independently regenerated in the Company Information page.
• To make use of the keys:
  • All programs that use the API can use the same API key. That way if, one of them is changed, the programs can switch to using the second key while the first is retired.
• In order to expedite any such changes, any program that uses Pulpstream APIs should put they key they are using into one easily-changed variable. ("Hardcoding" the API key is not advised, as it becomes harder to make changes, and to be certain that every API call was modified.)
• The content type for all calls is application/json.