Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.97 KB

Authentication.md

File metadata and controls

38 lines (26 loc) · 1.97 KB

Morf Logo

Authenticating with Morf Services

In order to use any Morf Service (API), you must provide a token for authentication. This token is known as a siteKey and is tied to a specific domain. In the Morf Editor, you'll notice the siteKey in the config section at the top of the Morf form JSON.

"config": {
    "submit": "",
    "siteKey": "abc123",
    "successUrl": "",
    "theme": "",
    "externalId": ""
}

In this example, the siteKey (abc123) is tied to a specific domain. In order to render and submit forms on other domains, you'll need to request a valid siteKey that is tied to that domain.

Authentication Mechanisms

There are two ways of using an API token.

  • as part of an API call where the token is present in the API-Key header; and
  • as part of a request where the token is present in the siteKey query parameter of the URL (e.g. https://render.getmorf.io/v1?site-key=abc123).

For security reasons, a siteKey should not be used to access API services since a siteKey is designed to be available publicly whereas an API Key is not.

Requesting a siteKey

In order to request a siteKey, email the Morf team at support@getmorf.io.

You'll need to provide:

  • your name;
  • your organization's name; and
  • a valid domain(s) from where the siteKey will be used.

Any form submissions using this siteKey will consume one of your organization's licensed submission transactions. If you are using the Morf free trial a submission will consume one of your 1,000 free transactions.

Once you receive your siteKey, use it to replace the siteKey in the config section of your form or in any queries to Morf services.