Authentication

To authenticate with , you'll need an API key and secret. You can get these by contacting the Origami team. Describe your use-case in detail so that we can assign your key appropriate permissions (READ, WRITE, or ADMIN). The documentation for each endpoint outlines which permission you'll need.

Once you have credentials, most API methods require you to provide the key and secret in HTTP headers. You can use a query parameter rather than headers, but be careful when using this approach as it's easier to accidentally expose your secret.

The headers or query parameters required by the service are:

Header Query Parameter Value
X-Api-Key apiKey The API key that was provided by the Origami team
X-Api-Secret apiSecret The API secret key that was provided by the Origami team